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