Update 2005-08-31 evening.
[git.git] / TODO
1 What to expect after 0.99.5
2 ===========================
3
4 This is written in a form of to-do list for me, so if I say
5 "accept patch", it means I do not currently plan to do that
6 myself.  People interested in seeing it materialize please take
7 a hint.
8
9
10 Documentation
11 -------------
12
13 * Accept patches from people who actually have done CVS
14   migration and update the cvs-migration documentation.
15   Link the documentation from the main git.txt page.
16
17 * Link howto docs from the git.txt page. [DONE]
18
19 * Update the SubmittingPatches document to add MUA specific
20   hints on how to disable unwanted MIME and flowed-text by
21   collecting past list postings [DONE].  Accept patches from
22   people who were hit by shiny blue bat to update the same [IN
23   PROGRESS].
24
25 * Talk about using rsync just once at the beginning when
26   initializing a remote repository so that local packs do not
27   need to be expanded.  I personally do not think we need tool
28   support for this.
29
30 * Review the existing docs and see if the repository
31   organization needs to be clarified further [STILL NEEDSWORK].
32
33 * Update tutorial to cover shared repository style a bit more
34   [DONE], maybe with a toy project that involves two or three
35   repositories.
36
37 * Update tutorial to cover setting up repository hooks to do
38   common tasks. [IN PROGRESS]
39
40 * Get help to properly use asciidoc in tutorial [Heck, ended up
41   learning it myself, DONE].
42
43 * Maybe justify and demonstrate an Octopus in the tutorial
44   [STILL NEEDSWORK].  Add it to the glossary [Thanks Johannes,
45   DONE].
46
47
48 Technical (heavier)
49 -------------------
50
51 * Tony Luck reported an unfortunate glitch in the 3-way merge.
52   Encourage discussions to come up with a not-so-expensive way
53   to catch the kind of ambiguities that led to his misery.
54   [STARTED TESTING PATCH FROM DANIEL]
55
56 * We might want to optimize cloning with GIT native transport
57   not to explode the pack, and store it in objects/pack instead.
58   We would need a tool to generate an idx file out of a pack
59   file for this.  Also this itself may turn out to be a bad
60   idea, making the set of packs in repositories everybody has
61   different from each other.
62
63 * Maybe a pack optimizer.  I am not convinced that packing all
64   objects into a single pack and removing all the existing panck
65   is the right way to go, since that would work against people
66   who already have those packs.
67
68
69 Technical (milder)
70 ------------------
71
72 * When the branch head pointed by $GIT_DIR/HEAD changes while
73   the index file and working tree are looking the other way
74   (e.g. somebody pushed into your repository, or you ran "git
75   fetch" to update the ref your working tree is on), "git
76   checkout" without -f gets confused.  Figure out a good way to
77   handle this. [DONE]
78
79   We still have the same issue with "git fetch".  Fetching into
80   the branch one is on _may_ need to do the same thing as
81   fetching into anonymous head and then do the resolve.  At
82   least it needs a warning. [DONE]
83
84 * "git commit -m" should work for initial commits and perhaps
85   merge commits as well.  Warning about merge is still a good
86   thing to do, while -m is useful in scripted non-interactive
87   use, so we need to be careful. [DONE]
88
89 * Encourage concrete proposals to commit log message templates
90   we discussed some time ago.
91
92 * Bug Ryan and work with him to update send-email easier to use.
93   [Resurrected it for Debian build.]
94
95 * Look at portability fixes from Jason Riedy
96
97     http://www.cs.berkeley.edu/~ejr/gits/git.git#portable 
98
99   [Applied.  Burned by one of them and backed out, but otherwise
100   looks OK.]
101
102 * Accept patches to cause "read-tree -u" delete a directory when
103   it makes it empty.
104
105 * Perhaps accept patches to introduce the concept of "patch flow
106   expressed as ref mappings" Josef has been advocating about.
107
108 * Perhaps accept patches to do undo/redo.
109
110 * MIMEified applymbox to grok B and Q encodings in headers and
111   turn them into UTF-8; unwrap QP; explode multipart.
112   [DONE. waiting for a bug to happen ;-) ]
113
114 * "git cherry-pick" that applies the patch an existing commit
115   introduces in its ancestry chain, possibly using the 3-way
116   merge machinery. [DONE]
117
118 * Update rebase using the cherry-pick command. [DONE]
119
120 * Redo "git revert" using 3-way merge machinery. [DONE]
121
122 * A tool to detect, show and prune already merged topic
123   branches.
124
125 * Set up an automated documentation rebuilding procedure at
126   kernel.org, using update hook mechanism. [DONE]  Describe it
127   in a howto form [DONE].
128
129 * Enhance "git repack" to not always use --all; this would be
130   handy if the repository contains wagging heads like "pu" in
131   git.git repository.
132
133 * Accept and apply "git repack --all" patch, except the part
134   that removes the existing packs. [DONE]
135
136 * Internally split the project into non-doc and doc parts; add
137   an extra root for the doc part and merge from it; move the
138   internal doc source to a separate repository, like the +Meta
139   repository; experiment if this results in a reasonable
140   workflow, and document it in howto form if it does.
141
142 * Add names to all nodes in show-branch [DONE].
143
144 * Option to limit rename detection for more than N paths.
145
146
147 Technical (trivial)
148 -------------------
149
150 * Look at and merge Debian fixes from Tommi [Done].
151
152 * Perhaps "git branch -d" to delete a branch.
153
154 * Remove "git clone-dumb-http".
155
156 * We would want test scripts for the relative directory path
157   stuff Linus has been working on.  So far, the following
158   commands should be usable with relative directory paths:
159
160     update-cache
161     ls-files
162     diff-files
163     diff-cache
164     diff-tree
165     rev-list
166
167
168 Initial repository Gotchas
169 --------------------------
170
171 * `git fetch foo:bar` works OK, but `git checkout bar`
172   afterwards does not (missing `.git/HEAD`)
173   
174 * `git commit -s` did not add signoff for initial commit [DONE].
175
176 * `git status` does not work well when missing `.git/HEAD` [DONE].
177
178 * `git log` either; git-log-script uses die which does not exist
179   [DONE].
180
181 \f
182 Local Variables:
183 mode: text
184 End: