Update 2005-08-26 (early morning)
[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.  Accept patches from people who
22   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.
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
49 * We might want to optimize cloning with GIT native transport
50   not to explode the pack, and store it in objects/pack instead.
51   We would need a tool to generate an idx file out of a pack
52   file for this.  Also this itself may turn out to be a bad
53   idea, making the set of packs in repositories everybody has
54   different from each other.
55
56 Technical (milder)
57 ------------------
58
59 * When the branch head pointed by $GIT_DIR/HEAD changes while
60   the index file and working tree are looking the other way
61   (e.g. somebody pushed into your repository, or you ran "git
62   fetch" to update the ref your working tree is on), "git
63   checkout" without -f gets confused.  Figure out a good way to
64   handle this. [DONE - waiting for response]
65
66 * "git commit -m" should work for initial commits and perhaps
67   merge commits as well.  Warning about merge is still a good
68   thing to do, while -m is useful in scripted non-interactive
69   use, so we need to be careful. [DONE - waiting for response]
70
71 * Encourage concrete proposals to commit log message templates
72   we discussed some time ago.
73
74 * Bug Ryan and work with him to update send-email easier to use.
75   [Resurrected it for Debian build.]
76
77 * Look at portability fixes from Jason Riedy
78
79     http://www.cs.berkeley.edu/~ejr/gits/git.git#portable 
80
81   [Looked at it.  Maybe promising.  Maybe not.]
82
83 * Accept patches to cause "read-tree -u" delete a directory when
84   it makes it empty.
85
86 * Perhaps accept patches to introduce the concept of "patch flow
87   expressed as ref mappings" Josef has been advocating about.
88
89 * Perhaps accept patches to do undo/redo, but I am reluctant to
90   add commands to cover very limited use cases right now.
91
92 * MIMEified applymbox to grok B and Q encodings in headers and
93   turn them into UTF-8; unwrap QP; explode multipart.
94
95 * "git cherry-pick" that applies the patch an existing commit
96   introduces in its ancestry chain, possibly using the 3-way
97   merge machinery; update rebase using the cherry-pick command.
98   Carl's redo/undo might fall out naturally from this.
99
100 * Redo "git revert" using 3-way merge machinery. [Done.]
101
102 * A tool to detect, show and prune already merged topic
103   branches.
104
105 * Set up an automated documentation rebuilding procedure at
106   kernel.org, using update hook mechanism. [Almost, but not quite.]
107
108 * Enhance "git repack" to not always use --all; this would be
109   handy if the repository contains wagging heads like "pu" in
110   git.git repository.
111
112
113 Technical (trivial)
114 -------------------
115
116 * Perhaps "git branch -d" to delete a branch.
117
118 * Remove "git clone-dumb-http".
119
120 * We would want test scripts for the relative directory path
121   stuff Linus has been working on.  So far, the following
122   commands should be usable with relative directory paths:
123
124     update-cache
125     ls-files
126     diff-files
127     diff-cache
128     diff-tree
129     rev-list