9184d1620cce1defa227e83561b96fc888991ef4
[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   [Preferably before 1.0]
109
110 * Plug-in file-level merges [Post 1.0].
111
112 * Per-repository configuration mechanism.
113
114
115 Technical (milder)
116 ------------------
117
118 * Review the Makefile variables and exporting rules for them,
119   while looking at prefix passing by Kai Ruemmler [DONE].
120
121 * Review the 'sparce object database' change by Linus and move
122   the first phase of it to the "master" branch [DONE].
123
124 * Decide on mmap().  I am inclined to just stick to mmap
125   replacement by Johannes Schindelin and do nothing else right
126   now, except perhaps drop the writing-back support [DONE].
127
128 * Revisit Santi's patch to move commit temorary files out of the
129   working tree toplevel [DONE].
130
131 * More generally, review the use of temporary files again.
132   Assuming $GIT_DIR is writable is more acceptable, but the
133   working tree toplevel may not be in a rare usage pattern.
134
135 * Perhaps accept more "want"s in upload-pack and do something
136   intelligent about it.
137
138 * Perhaps detect cloning request in upload-pack and cache the
139   result for next cloning request until any of our refs change.
140
141 * Perhaps send less "want"s from fetch-pack.
142
143 * Encourage concrete proposals to commit log message templates
144   we discussed some time ago.
145
146 * Accept patches to cause "read-tree -u" delete a directory when
147   it makes it empty.
148
149 * Perhaps accept patches to do undo/redo.
150
151 * Perhaps accept patch to optionally allow '--fuzz' in
152   'git-apply'.
153
154 * Allow 'git apply' to accept GNU diff 2.7 output that forgets
155   to say '\No newline' if both input ends with incomplete
156   lines.
157
158 * What to do with TABs and LFs in pathnames without breaking GNU
159   patch? 
160
161 * Maybe grok PGP signed text/plain in applymbox as well.
162
163 * Perhaps a tool to revert a single file to pre-modification
164   state?  People with BK background know this operation as
165   'clean'.  'git checkout [-f] ent [path...]' was suggested by
166   Matthias Urlichs which sounds a natural extention to what the
167   command currently does.
168
169 * Enhance "git repack" to not always use --all; this would be
170   handy if the repository contains wagging heads like "pu" in
171   git.git repository.
172
173 * Internally split the project into non-doc and doc parts; add
174   an extra root for the doc part and merge from it; move the
175   internal doc source to a separate repository, like the +Meta
176   repository; experiment if this results in a reasonable
177   workflow, and document it in howto form if it does.
178
179   The point is to make it possible to fork that part off to
180   somebody else; then I do not have to maintain Documentation
181   directory myself anymore, just like I simply slurp the latest
182   gitk from Paul and not worry about it ;-).
183
184 * Make rebase restartable; instead of skipping what cannot be
185   automatically forward ported, leave the conflicts in the work
186   tree, have the user resolve it, and then restart from where it
187   left off.
188
189 * Output full path in the "git-rev-list --objects" output, not
190   just the basename, and see the improved clustering results in
191   better packing [Tried, but did not work out well].
192
193 * Updated git-changes-script Jeff Garzik needs [Inquiry for
194   external spec sent out with a quick hack.  Will know if that
195   is what he needs soon enough].
196
197 * An mechanism to ignore filesystem mode bits altogether.
198
199
200 Technical (trivial)
201 -------------------
202
203 * short SHA1 naming is not enforcing uniqueness.  Should fix [DONE].
204
205 * 'git repack' can be DOSed.  Should fix [DONE].
206
207 * Stop installing the old-name symlinks [POSTPONED, but before 1.0].
208
209 * 'git merge-projects'?
210
211   Subject: Re: Merges without bases
212   References: <1125004228.4110.20.camel@localhost.localdomain>
213   Date: Thu, 25 Aug 2005 15:26:36 -0700
214   Message-ID: <7vvf1tps9v.fsf@assigned-by-dhcp.cox.net>
215
216 * 'git lost-and-found'?  Link dangling commits found by
217   fsck-objects under $GIT_DIR/refs/lost-found/.  Then
218   show-branch or gitk can be used to find any lost commit. [A
219   feeler patch sent out. Very underwhelming response X-<.]
220
221   Do not name it /lost+found/; that would probably confuse
222   things that mistake it a mount point (not our code but
223   somebody else's).
224
225 * Add simple globbing rules to git-show-branch so that I can
226   say 'git show-branch --heads "ko-*"' (ko-master, ko-pu, and
227   ko-rc are in refs/tags/).
228
229 * We would want test scripts for the relative directory path
230   stuff Linus has been working on.  So far, the following
231   commands should be usable with relative directory paths:
232
233     git-update-index
234     git-ls-files
235     git-diff-files
236     git-diff-index
237     git-diff-tree
238     git-rev-list
239     git-rev-parse
240
241 * In a freashly created empty repository, `git fetch foo:bar`
242   works OK, but `git checkout bar` afterwards does not (missing
243   `.git/HEAD`).
244
245 \f
246 Local Variables:
247 mode: text
248 End: