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