Updates 2005-10-10
[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.
72
73 * Git daemon, when deployed at kernel.org, might turn out to be
74   quite a burden, since it needs to generate customized packs
75   every time a new request comes in.  It may be worthwhile to
76   precompute some packs for popular sets of heads downloaders
77   have and serve that, even if that could give more than the
78   client asks for in some cases.  We will know about this soon
79   enough.
80
81 * Libification.  There are many places "run once" mentality is
82   ingrained in the management of basic data structures, which
83   need to be fixed.  [Matthias Urlichs is already working on
84   this: <pan.2005.10.03.20.48.52.132570@smurf.noris.de>; Post
85   1.0].
86
87 * Maybe a pack optimizer.
88
89   Given a set of objects and a set of refs (probably a handful
90   branch heads and point release tags), find a set of packs to
91   allow reasonably minimum download for all of these classes of
92   people: (1) somebody cloning the repository from scratch, (2)
93   somebody who tends to follow the master branch head reasonably
94   closely, (3) somebody who tends to follow only the point
95   releases.
96
97 * Maybe an Emacs VC backend.
98
99 * 'git split-projects'?  This requires updated 'git-rev-list' to
100   skip irrelevant commits.
101   Message-ID: <Pine.LNX.4.63.0509221617300.23242@iabervon.org>
102
103 * Look at libified GNU diff CVS seems to use, or libxdiff.
104   [Daniel has his own diff tool almost ready to start
105   integrating and testing; Post 1.0]
106
107 * Accept patches to fetch multiple objects by HTTP in parallel.
108   [DONE]
109
110 * Plug-in file-level merges [Post 1.0].
111
112 * Per-repository configuration mechanism.
113
114
115 Technical (milder)
116 ------------------
117
118 * Funny tag names and curl library.
119
120   curl 'http://locke.catalyst.net.nz/git/moodle.git/refs/tags/MOODLE_15_MERGED **INVALID**'
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 'sparce 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.
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?  [Discussion started.]
164
165 * Maybe grok PGP signed text/plain in applymbox as well.
166
167 * Perhaps a tool to revert a single file to pre-modification
168   state?  People with BK background know this operation as
169   'clean'.  'git checkout [-f] ent [path...]' was suggested by
170   Matthias Urlichs which sounds a natural extention to what the
171   command currently does.
172
173 * Enhance "git repack" to not always use --all; this would be
174   handy if the repository contains wagging heads like "pu" in
175   git.git repository.
176
177 * Internally split the project into non-doc and doc parts; add
178   an extra root for the doc part and merge from it; move the
179   internal doc source to a separate repository, like the +Meta
180   repository; experiment if this results in a reasonable
181   workflow, and document it in howto form if it does.
182
183   The point is to make it possible to fork that part off to
184   somebody else; then I do not have to maintain Documentation
185   directory myself anymore, just like I simply slurp the latest
186   gitk from Paul and not worry about it ;-).
187
188 * Make rebase restartable; instead of skipping what cannot be
189   automatically forward ported, leave the conflicts in the work
190   tree, have the user resolve it, and then restart from where it
191   left off.
192
193 * Output full path in the "git-rev-list --objects" output, not
194   just the basename, and see the improved clustering results in
195   better packing [Tried, but did not work out well].
196
197 * Updated git-changes-script Jeff Garzik needs [Inquiry for
198   external spec sent out with a quick hack.  Will know if that
199   is what he needs soon enough].
200
201 * An mechanism to ignore filesystem mode bits altogether.
202
203
204 Technical (trivial)
205 -------------------
206
207 * short SHA1 naming is not enforcing uniqueness.  Should fix [DONE].
208
209 * 'git repack' can be DOSed.  Should fix [DONE].
210
211 * Stop installing the old-name symlinks [POSTPONED, but before 1.0].
212
213 * 'git merge-projects'?
214
215   Subject: Re: Merges without bases
216   References: <1125004228.4110.20.camel@localhost.localdomain>
217   Date: Thu, 25 Aug 2005 15:26:36 -0700
218   Message-ID: <7vvf1tps9v.fsf@assigned-by-dhcp.cox.net>
219
220 * 'git lost-and-found'?  Link dangling commits found by
221   fsck-objects under $GIT_DIR/refs/lost-found/.  Then
222   show-branch or gitk can be used to find any lost commit. [A
223   feeler patch sent out. Very underwhelming response X-<.]
224
225   Do not name it /lost+found/; that would probably confuse
226   things that mistake it a mount point (not our code but
227   somebody else's).
228
229 * Add simple globbing rules to git-show-branch so that I can
230   say 'git show-branch --heads "ko-*"' (ko-master, ko-pu, and
231   ko-rc are in refs/tags/).
232
233 * We would want test scripts for the relative directory path
234   stuff Linus has been working on.  So far, the following
235   commands should be usable with relative directory paths:
236
237     git-update-index
238     git-ls-files
239     git-diff-files
240     git-diff-index
241     git-diff-tree
242     git-rev-list
243     git-rev-parse
244
245 * In a freashly created empty repository, `git fetch foo:bar`
246   works OK, but `git checkout bar` afterwards does not (missing
247   `.git/HEAD`).
248
249 \f
250 Local Variables:
251 mode: text
252 End: