Update 2005-09-02 early morning.
[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.
30
31 * Review the existing docs and see if the repository
32   organization needs to be clarified further [STILL NEEDSWORK].
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.
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 * We might want to optimize cloning with GIT native transport
63   not to explode the pack, and store it in objects/pack instead.
64   We would need a tool to generate an idx file out of a pack
65   file for this.  Also this itself may turn out to be a bad
66   idea, making the set of packs in repositories everybody has
67   different from each other.
68
69 * Maybe a pack optimizer.  I am not convinced that packing all
70   objects into a single pack and removing all the existing panck
71   is the right way to go, since that would work against people
72   who already have those packs.
73
74 * Maybe an Emacs VC backend.
75
76
77 Technical (milder)
78 ------------------
79
80 * When the branch head pointed by $GIT_DIR/HEAD changes while
81   the index file and working tree are looking the other way
82   (e.g. somebody pushed into your repository, or you ran "git
83   fetch" to update the ref your working tree is on), "git
84   checkout" without -f gets confused.  Figure out a good way to
85   handle this. [DONE]
86
87 * We still have the same issue with "git fetch".  Fetching into
88   the branch one is on _may_ need to do the same thing as
89   fetching into anonymous head and then do the resolve.  At
90   least it needs a warning. [DONE]
91
92 * "git commit -m" should work for initial commits and perhaps
93   merge commits as well.  Warning about merge is still a good
94   thing to do, while -m is useful in scripted non-interactive
95   use, so we need to be careful. [DONE]
96
97 * Encourage concrete proposals to commit log message templates
98   we discussed some time ago.
99
100 * Test apply.c patches from Robert Fitzsmons and have them
101   graduate to "master" branch.
102
103 * Bug Ryan and work with him to update send-email easier to use.
104   [Resurrected it for Debian build.]
105
106 * Look at portability fixes from Jason Riedy
107
108     http://www.cs.berkeley.edu/~ejr/gits/git.git#portable 
109
110   [Applied.  Burned by one of them and backed out, but otherwise
111   looks OK.]
112
113 * Accept patches to cause "read-tree -u" delete a directory when
114   it makes it empty.
115
116 * Perhaps accept patches to introduce the concept of "patch flow
117   expressed as ref mappings" Josef has been advocating about.
118
119 * Perhaps accept patches to do undo/redo.
120
121 * MIMEified applymbox to grok B and Q encodings in headers and
122   turn them into UTF-8; unwrap QP; explode multipart.
123   [DONE. waiting for a bug to happen ;-) ]
124
125 * Maybe grok PGP signed text/plain in applymbox as well.
126
127 * Perhaps a tool to revert a single file to pre-modification
128   state?  git-cat-file blob `git-ls-files | grep foo` >foo or
129   git-cat-file blob `git-ls-tree HEAD foo` >foo?  What should
130   the command be called?  git-revert is taken so is
131   git-checkout.
132
133 * "git cherry-pick" that applies the patch an existing commit
134   introduces in its ancestry chain, possibly using the 3-way
135   merge machinery. [DONE]
136
137 * Update rebase using the cherry-pick command. [DONE]
138
139 * Redo "git revert" using 3-way merge machinery. [DONE]
140
141 * A tool to detect, show and prune already merged topic
142   branches.
143
144 * Set up an automated documentation rebuilding procedure at
145   kernel.org, using update hook mechanism. [DONE]
146
147 * Describe automated documentation rebuilding in a howto form
148   [DONE].
149
150 * Enhance "git repack" to not always use --all; this would be
151   handy if the repository contains wagging heads like "pu" in
152   git.git repository.
153
154 * Accept and apply "git repack --all" patch, except the part
155   that removes the existing packs. [DONE]
156
157 * Internally split the project into non-doc and doc parts; add
158   an extra root for the doc part and merge from it; move the
159   internal doc source to a separate repository, like the +Meta
160   repository; experiment if this results in a reasonable
161   workflow, and document it in howto form if it does.
162
163 * Add names to all nodes in show-branch [DONE].
164
165 * Option to limit rename detection for more than N paths.
166
167
168 Technical (trivial)
169 -------------------
170
171 * Look at and merge Debian fixes from Tommi [Done].
172
173 * Perhaps "git branch -d" to delete a branch.
174
175 * Remove "git clone-dumb-http".
176
177 * We would want test scripts for the relative directory path
178   stuff Linus has been working on.  So far, the following
179   commands should be usable with relative directory paths:
180
181     update-cache
182     ls-files
183     diff-files
184     diff-cache
185     diff-tree
186     rev-list
187
188
189 Initial repository Gotchas
190 --------------------------
191
192 * `git fetch foo:bar` works OK, but `git checkout bar`
193   afterwards does not (missing `.git/HEAD`)
194   
195 * `git commit -s` did not add signoff for initial commit [DONE].
196
197 * `git status` does not work well when missing `.git/HEAD` [DONE].
198
199 * `git log` either; git-log-script uses die which does not exist
200   [DONE].
201
202 \f
203 Local Variables:
204 mode: text
205 End: