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