Updates 2005-10-12 night.
[git.git] / TODO
1 The GIT To-Do File
2 ==================
3
4   The latest copy of this document is found at 
5
6     http://kernel.org/git/?p=git/git.git;a=blob;hb=todo;f=TODO
7
8
9 Tool Renames Plan
10 =================
11
12  - In 0.99.8, we will still install the backward compatible
13    symbolic links in $(bindir).  These will however be removed
14    before 1.0 happens.
15
16    git-ssh-push and git-ssh-pull pair is not going away within
17    this timeframe, if ever.  Each of these old-name commands
18    continues to invoke its old-name counterpart on the other
19    end.
20
21
22 What to expect after 0.99.8
23 ===========================
24
25 This is written in a form of to-do list for me, so if I say
26 "accept patch", it means I do not currently plan to do that
27 myself.  People interested in seeing it materialize please take
28 a hint.  Also whatever I marked "Perhaps" do not have to happen
29 if ever -- only if somebody cares enough and submits a clean
30 patch, perhaps ;-).
31
32
33 Documentation
34 -------------
35
36 * Help Jon Loeliger to find place in the documentation to place
37   his drawing.
38
39 * Accept patches from people who actually have done CVS
40   migration and update the cvs-migration documentation.
41   Link the documentation from the main git.txt page.
42
43 * Talk about using rsync just once at the beginning when
44   initializing a remote repository so that local packs do not
45   need to be expanded.  I personally do not think we need tool
46   support for this (but see below about optimized cloning).
47
48 * Maybe update tutorial with a toy project that involves two or
49   three developers..
50
51 * Update tutorial to cover setting up repository hooks to do
52   common tasks.
53
54 * Accept patches to finish missing docs.
55
56 * Accept patches to talk about "Whoops, it broke.  What's
57   next?".
58
59 * Accept patches to make formatted tables in asciidoc to work
60   well in both html and man pages (see git-diff(1)).
61
62
63 Technical (heavier)
64 -------------------
65
66 * We might want to optimize cloning with GIT native transport
67   not to explode the pack, and store it in objects/pack instead.
68   We would need a tool to generate an idx file out of a pack
69   file for this.  Also this itself may turn out to be a bad
70   idea, making the set of packs in repositories everybody has
71   different from each other. [DONE; git-index-pack by Sergey,
72   tweaking clone by me]
73
74 * Git daemon, when deployed at kernel.org, might turn out to be
75   quite a burden, since it needs to generate customized packs
76   every time a new request comes in.  It may be worthwhile to
77   precompute some packs for popular sets of heads downloaders
78   have and serve that, even if that could give more than the
79   client asks for in some cases.  We will know about this soon
80   enough.
81
82 * Libification.  There are many places "run once" mentality is
83   ingrained in the management of basic data structures, which
84   need to be fixed.  [Matthias Urlichs is already working on
85   this: <pan.2005.10.03.20.48.52.132570@smurf.noris.de>; Post
86   1.0].
87
88 * Maybe a pack optimizer.
89
90   Given a set of objects and a set of refs (probably a handful
91   branch heads and point release tags), find a set of packs to
92   allow reasonably minimum download for all of these classes of
93   people: (1) somebody cloning the repository from scratch, (2)
94   somebody who tends to follow the master branch head reasonably
95   closely, (3) somebody who tends to follow only the point
96   releases.
97
98 * Maybe an Emacs VC backend.
99
100 * 'git split-projects'?  This requires updated 'git-rev-list' to
101   skip irrelevant commits.
102   Message-ID: <Pine.LNX.4.63.0509221617300.23242@iabervon.org>
103
104 * Look at libified GNU diff CVS seems to use, or libxdiff.
105   [Daniel has his own diff tool almost ready to start
106   integrating and testing; Post 1.0]
107
108 * Accept patches to fetch multiple objects by HTTP in parallel.
109   [DONE]
110
111 * Plug-in file-level merges [Post 1.0].
112
113 * Per-repository configuration mechanism [DONE by Linus].
114
115
116 Technical (milder)
117 ------------------
118
119 * Quote the URL so that libcurl's metecharacter mechanism would
120   not kick in [DONE].
121
122 * Review the Makefile variables and exporting rules for them,
123   while looking at prefix passing by Kai Ruemmler [DONE].
124
125 * Review the 'sparse object database' change by Linus and move
126   the first phase of it to the "master" branch [DONE].
127
128 * Decide on mmap().  I am inclined to just stick to mmap
129   replacement by Johannes Schindelin and do nothing else right
130   now, except perhaps drop the writing-back support [DONE].
131
132 * Revisit Santi's patch to move commit temorary files out of the
133   working tree toplevel [DONE].
134
135 * More generally, review the use of temporary files again.
136   Assuming writable $GIT_DIR is more acceptable, but the
137   working tree toplevel may not be in a rare usage pattern.
138
139 * Perhaps accept more "want"s in upload-pack and do something
140   intelligent about it.
141
142 * Perhaps detect cloning request in upload-pack and cache the
143   result for next cloning request until any of our refs change.
144
145 * Perhaps send less "want"s from fetch-pack.
146
147 * Encourage concrete proposals to commit log message templates
148   we discussed some time ago.
149
150 * Accept patches to cause "read-tree -u" delete a directory when
151   it makes it empty [DONE].
152
153 * Perhaps accept patches to do undo/redo.
154
155 * Perhaps accept patch to optionally allow '--fuzz' in
156   'git-apply'.
157
158 * Allow 'git apply' to accept GNU diff 2.7 output that forgets
159   to say '\No newline' if both input ends with incomplete
160   lines.
161
162 * What to do with TABs and LFs in pathnames without breaking GNU
163   patch?  [Have patch in proposed updates.  Discussion still
164   ongoing with Paul.]
165
166 * Maybe grok PGP signed text/plain in applymbox as well.
167
168 * Perhaps a tool to revert a single file to pre-modification
169   state?  People with BK background know this operation as
170   'clean'.  'git checkout [-f] ent [path...]' was suggested by
171   Matthias Urlichs which sounds a natural extention to what the
172   command currently does.
173
174 * Enhance "git repack" to not always use --all; this would be
175   handy if the repository contains wagging heads like "pu" in
176   git.git repository.
177
178 * Internally split the project into non-doc and doc parts; add
179   an extra root for the doc part and merge from it; move the
180   internal doc source to a separate repository, like the +Meta
181   repository; experiment if this results in a reasonable
182   workflow, and document it in howto form if it does.
183
184   The point is to make it possible to fork that part off to
185   somebody else; then I do not have to maintain Documentation
186   directory myself anymore, just like I simply slurp the latest
187   gitk from Paul and not worry about it ;-).
188
189 * Make rebase restartable; instead of skipping what cannot be
190   automatically forward ported, leave the conflicts in the work
191   tree, have the user resolve it, and then restart from where it
192   left off [mechanism mostly done].
193
194 * Output full path in the "git-rev-list --objects" output, not
195   just the basename, and see the improved clustering results in
196   better packing [Tried, but did not work out well].
197
198 * Updated git-changes-script Jeff Garzik needs [Inquiry for
199   external spec sent out with a quick hack.  Will know if that
200   is what he needs hopefully soon].
201
202 * An mechanism to ignore filesystem mode bits altogether [DONE].
203
204
205 Technical (trivial)
206 -------------------
207
208 * Disallow [\001-\040\177] byte values from ref names.  Also we
209   need to disallow ':' (used in refspec), '^' and '~' (postfix
210   "peel the onion" operators) and leading '+' (again used in
211   refspec, as prefix "force update" operator) [DONE].
212
213 * short SHA1 naming is not enforcing uniqueness.  Should fix [DONE].
214
215 * 'git repack' can be DOSed.  Should fix [DONE].
216
217 * Stop installing the old-name symlinks [POSTPONED, but before 1.0].
218
219 * 'git merge-projects'?
220
221   Subject: Re: Merges without bases
222   References: <1125004228.4110.20.camel@localhost.localdomain>
223   Date: Thu, 25 Aug 2005 15:26:36 -0700
224   Message-ID: <7vvf1tps9v.fsf@assigned-by-dhcp.cox.net>
225
226 * 'git lost-and-found'?  Link dangling commits found by
227   fsck-objects under $GIT_DIR/refs/lost-found/.  Then
228   show-branch or gitk can be used to find any lost commit. [A
229   feeler patch sent out. Very underwhelming response X-<.]
230
231   Do not name it /lost+found/; that would probably confuse
232   things that mistake it a mount point (not our code but
233   somebody else's).
234
235 * Add simple globbing rules to git-show-branch so that I can
236   say 'git show-branch --heads "ko-*"' (ko-master, ko-pu, and
237   ko-rc are in refs/tags/).
238
239 * We would want test scripts for the relative directory path
240   stuff Linus has been working on.  So far, the following
241   commands should be usable with relative directory paths:
242
243     git-update-index
244     git-ls-files
245     git-diff-files
246     git-diff-index
247     git-diff-tree
248     git-rev-list
249     git-rev-parse
250
251 * In a freashly created empty repository, `git fetch foo:bar`
252   works OK, but `git checkout bar` afterwards does not (missing
253   `.git/HEAD`).
254
255 \f
256 Local Variables:
257 mode: text
258 End: