-What to expect after 0.99.5
+The GIT To-Do File
+==================
+
+ The latest copy of this document is found at
+
+ http://kernel.org/git/?p=git/git.git;a=blob;hb=todo;f=TODO
+
+
+Tool Renames Plan
+=================
+
+ - In 0.99.8, we still install the backward compatible symbolic
+ links in $(bindir). These will however be removed before 1.0
+ happens.
+
+ git-ssh-push and git-ssh-pull pair is not going away within
+ this timeframe, if ever. Each of these old-name commands
+ continues to invoke its old-name counterpart on the other
+ end.
+
+
+What to expect after 0.99.8
===========================
This is written in a form of to-do list for me, so if I say
"accept patch", it means I do not currently plan to do that
myself. People interested in seeing it materialize please take
-a hint.
+a hint. Also whatever I marked "Perhaps" do not have to happen
+if ever -- only if somebody cares enough and submits a clean
+patch, perhaps ;-).
Documentation
-------------
+* Document the ref naming restrictions [DONE].
+
+* David Ho's report suggests whatchanged documentation should
+ mention -m as "commonly used options". Steal Linus'
+ response [DONE].
+
+* Help Jon Loeliger to find place in the documentation to place
+ his drawing.
+
* Accept patches from people who actually have done CVS
migration and update the cvs-migration documentation.
Link the documentation from the main git.txt page.
-* Link howto docs from the git.txt page. [DONE]
-
-* Update the SubmittingPatches document to add MUA specific
- hints on how to disable unwanted MIME and flowed-text by
- collecting past list postings [DONE]. Accept patches from
- people who were hit by shiny blue bat to update the same [IN
- PROGRESS].
-
* Talk about using rsync just once at the beginning when
initializing a remote repository so that local packs do not
need to be expanded. I personally do not think we need tool
- support for this.
-
-* Review the existing docs and see if the repository
- organization needs to be clarified further [STILL NEEDSWORK].
+ support for this (but see below about optimized cloning).
-* Update tutorial to cover shared repository style a bit more
- [DONE], maybe with a toy project that involves two or three
- repositories.
+* Maybe update tutorial with a toy project that involves two or
+ three developers..
* Update tutorial to cover setting up repository hooks to do
- common tasks. [IN PROGRESS]
+ common tasks.
-* Get help to properly use asciidoc in tutorial [Heck, ended up
- learning it myself, DONE].
+* Do we still have missing docs? If so accept patches to finish
+ them.
-* Maybe justify and demonstrate an Octopus in the tutorial
- [STILL NEEDSWORK]. Add it to the glossary [Thanks Johannes,
- DONE].
+* Accept patches to talk about "Whoops, it broke. What's
+ next?".
+
+* Accept patches to make formatted tables in asciidoc to work
+ well in both html and man pages (see git-diff(1)).
Technical (heavier)
-------------------
-* Tony Luck reported an unfortunate glitch in the 3-way merge.
- Encourage discussions to come up with a not-so-expensive way
- to catch the kind of ambiguities that led to his misery.
- [Daniel's patch look promising, just by judging from how clean
- the re-organization part of read-tree looks like.]
-
* We might want to optimize cloning with GIT native transport
not to explode the pack, and store it in objects/pack instead.
We would need a tool to generate an idx file out of a pack
file for this. Also this itself may turn out to be a bad
idea, making the set of packs in repositories everybody has
- different from each other.
+ different from each other. [DONE; git-index-pack by Sergey,
+ tweaking clone by me]
+
+* Git daemon, when deployed at kernel.org, might turn out to be
+ quite a burden, since it needs to generate customized packs
+ every time a new request comes in. It may be worthwhile to
+ precompute some packs for popular sets of heads downloaders
+ have and serve that, even if that could give more than the
+ client asks for in some cases. We will know about this soon
+ enough.
+
+* Libification. There are many places "run once" mentality is
+ ingrained in the management of basic data structures, which
+ need to be fixed. [Matthias Urlichs is already working on
+ this: <pan.2005.10.03.20.48.52.132570@smurf.noris.de>; Post
+ 1.0].
+
+* Maybe a pack optimizer.
+
+ Given a set of objects and a set of refs (probably a handful
+ branch heads and point release tags), find a set of packs to
+ allow reasonably minimum download for all of these classes of
+ people: (1) somebody cloning the repository from scratch, (2)
+ somebody who tends to follow the master branch head reasonably
+ closely, (3) somebody who tends to follow only the point
+ releases.
+
+* Maybe an Emacs VC backend.
-* Maybe a pack optimizer. I am not convinced that packing all
- objects into a single pack and removing all the existing panck
- is the right way to go, since that would work against people
- who already have those packs.
+* 'git split-projects'? This requires updated 'git-rev-list' to
+ skip irrelevant commits.
+ Message-ID: <Pine.LNX.4.63.0509221617300.23242@iabervon.org>
+
+* Look at libified GNU diff CVS seems to use, or libxdiff.
+ [Daniel has his own diff tool almost ready to start
+ integrating and testing; Post 1.0]
+
+* Accept patches to fetch multiple objects by HTTP in parallel.
+ [DONE]
+
+* Plug-in file-level merges [Post 1.0].
+
+* Per-repository configuration mechanism [DONE by Linus].
Technical (milder)
------------------
-* When the branch head pointed by $GIT_DIR/HEAD changes while
- the index file and working tree are looking the other way
- (e.g. somebody pushed into your repository, or you ran "git
- fetch" to update the ref your working tree is on), "git
- checkout" without -f gets confused. Figure out a good way to
- handle this. [DONE]
+* Merlyn reports trouble with http fetch.
- We still have the same issue with "git fetch". Fetching into
- the branch one is on _may_ need to do the same thing as
- fetching into anonymous head and then do the resolve. At
- least it needs a warning. [DONE]
+* Maybe look at Cogito and see if I can help Pasky to adjust to
+ the later core features? Zack Brown's "cg-seek leaving empty
+ directories" problem is a good example of this.
-* "git commit -m" should work for initial commits and perhaps
- merge commits as well. Warning about merge is still a good
- thing to do, while -m is useful in scripted non-interactive
- use, so we need to be careful. [DONE]
+* Perhaps detect cloning request in upload-pack and cache the
+ result for next cloning request until any of our refs change.
-* Encourage concrete proposals to commit log message templates
- we discussed some time ago.
+* Perhaps accept more "want"s in upload-pack and do something
+ intelligent about it.
-* Bug Ryan and work with him to update send-email easier to use.
- [Resurrected it for Debian build.]
+* Perhaps send less "want"s from fetch-pack.
-* Look at portability fixes from Jason Riedy
+* Look at svn importer Smurf has. There is a small cvsimport
+ update in his tree as well [DONE].
- http://www.cs.berkeley.edu/~ejr/gits/git.git#portable
+* Decide the notation of "peeling the onion" operator, and
+ implement it in sha1_name.c. Perhaps postfix "^{}" to mean
+ "peel and expect anything", "^{blob}" to mean "peel and barf
+ unless blob". The current "^0" becomes shorthand for
+ "^{commit}". [DONE]
- [Applied. Burned by one of them and backed out, but otherwise
- looks OK.]
+* Quote the URL so that libcurl's metecharacter mechanism would
+ not kick in [DONE].
-* Accept patches to cause "read-tree -u" delete a directory when
- it makes it empty.
+* Review the Makefile variables and exporting rules for them,
+ while looking at prefix passing by Kai Ruemmler [DONE].
-* Perhaps accept patches to introduce the concept of "patch flow
- expressed as ref mappings" Josef has been advocating about.
+* Review the 'sparse object database' change by Linus and move
+ the first phase of it to the "master" branch [DONE].
+
+* Decide on mmap(). I am inclined to just stick to mmap
+ replacement by Johannes Schindelin and do nothing else right
+ now, except perhaps drop the writing-back support [DONE].
+
+* Revisit Santi's patch to move commit temorary files out of the
+ working tree toplevel [DONE].
+
+* More generally, review the use of temporary files again.
+ Assuming writable $GIT_DIR is more acceptable, but the
+ working tree toplevel may not be in a rare usage pattern.
+
+* Encourage concrete proposals to commit log message templates
+ we discussed some time ago.
+
+* Accept patches to cause "read-tree -u" delete a directory when
+ it makes it empty [DONE].
* Perhaps accept patches to do undo/redo.
-* MIMEified applymbox to grok B and Q encodings in headers and
- turn them into UTF-8; unwrap QP; explode multipart.
- [DONE. waiting for a bug to happen ;-) ]
+* Perhaps accept patch to optionally allow '--fuzz' in
+ 'git-apply'.
+
+* Allow 'git apply' to accept GNU diff 2.7 output that forgets
+ to say '\No newline' if both input ends with incomplete
+ lines.
-* "git cherry-pick" that applies the patch an existing commit
- introduces in its ancestry chain, possibly using the 3-way
- merge machinery. [DONE]
+* What to do with TABs and LFs in pathnames without breaking GNU
+ patch? [DONE -- go with GNU patch extension proposed by Paul].
-* Update rebase using the cherry-pick command. [DONE]
+* Adjust apply.c to proposed GNU patch extension that quotes \n
+ and \t in C style, inside "". [DONE]
-* Redo "git revert" using 3-way merge machinery. [DONE]
+* Adjust diff.c to the same. [DONE]
-* A tool to detect, show and prune already merged topic
- branches.
+* Maybe grok PGP signed text/plain in applymbox as well.
-* Set up an automated documentation rebuilding procedure at
- kernel.org, using update hook mechanism. [DONE] Describe it
- in a howto form [DONE].
+* Perhaps a tool to revert a single file to pre-modification
+ state? People with BK background know this operation as
+ 'clean'. 'git checkout [-f] ent [path...]' was suggested by
+ Matthias Urlichs which sounds a natural extention to what the
+ command currently does [DONE with a prodding by Linus].
* Enhance "git repack" to not always use --all; this would be
handy if the repository contains wagging heads like "pu" in
git.git repository.
-* Accept and apply "git repack --all" patch, except the part
- that removes the existing packs. [DONE]
-
* Internally split the project into non-doc and doc parts; add
an extra root for the doc part and merge from it; move the
internal doc source to a separate repository, like the +Meta
repository; experiment if this results in a reasonable
workflow, and document it in howto form if it does.
-* Add names to all nodes in show-branch [DONE].
+ The point is to make it possible to fork that part off to
+ somebody else; then I do not have to maintain Documentation
+ directory myself anymore, just like I simply slurp the latest
+ gitk from Paul and not worry about it ;-).
+
+* Make rebase restartable; instead of skipping what cannot be
+ automatically forward ported, leave the conflicts in the work
+ tree, have the user resolve it, and then restart from where it
+ left off [mechanism mostly done].
-* Option to limit rename detection for more than N paths.
+* Output full path in the "git-rev-list --objects" output, not
+ just the basename, and see the improved clustering results in
+ better packing [Tried, but did not work out well].
+
+* Updated git-changes-script Jeff Garzik needs [Inquiry for
+ external spec sent out with a quick hack. Will know if that
+ is what he needs hopefully soon].
+
+* An mechanism to ignore filesystem mode bits altogether [DONE].
Technical (trivial)
-------------------
-* Look at and merge Debian fixes from Tommi [Done].
+* Peter Hagervall's sparse fix [DONE].
+
+* Alex Riesen reported that hooks are in effect in tests.
+ Should fix [DONE].
+
+* Disallow [\001-\040\177] byte values from ref names. Also we
+ need to disallow ':' (used in refspec), '^' and '~' (postfix
+ "peel the onion" operators), and '..' ("ref1..ref2" notation
+ becomes ambiguous otherwise) [DONE].
+
+* Update fetch-pack and clone-pack to ignore funny refs from the
+ other end, while making sure peek-remote does not discard them.
+ [DONE]
+
+* Update upload-pack to send tag^{}. This would hopefully help
+ Pasky's automated tag tracking, and also Martin's findtags.
+ [DONE]
+
+* Adjust update-index to quoted --index-info [DONE].
+
+* Prepare apply.c changes for maint branch (0.99.8e) [READY].
+
+* Perhaps show ^{commit}, ^{tree} instead of ^{} from ls-remote?
+
+* Re-adjust maint branch for the above if we did so.
+
+* short SHA1 naming is not enforcing uniqueness. Should fix [DONE].
+
+* 'git repack' can be DOSed. Should fix [DONE].
+
+* Stop installing the old-name symlinks [POSTPONED, but before 1.0].
+
+* 'git merge-projects'?
+
+ Subject: Re: Merges without bases
+ References: <1125004228.4110.20.camel@localhost.localdomain>
+ Date: Thu, 25 Aug 2005 15:26:36 -0700
+ Message-ID: <7vvf1tps9v.fsf@assigned-by-dhcp.cox.net>
+
+* 'git lost-and-found'? Link dangling commits found by
+ fsck-objects under $GIT_DIR/refs/lost-found/. Then
+ show-branch or gitk can be used to find any lost commit. [A
+ feeler patch sent out. Very underwhelming response X-<.]
-* Perhaps "git branch -d" to delete a branch.
+ Do not name it /lost+found/; that would probably confuse
+ things that mistake it a mount point (not our code but
+ somebody else's).
-* Remove "git clone-dumb-http".
+* Add simple globbing rules to git-show-branch so that I can
+ say 'git show-branch --heads "ko-*"' (ko-master, ko-pu, and
+ ko-rc are in refs/tags/).
* We would want test scripts for the relative directory path
stuff Linus has been working on. So far, the following
commands should be usable with relative directory paths:
- update-cache
- ls-files
- diff-files
- diff-cache
- diff-tree
- rev-list
+ git-update-index
+ git-ls-files
+ git-diff-files
+ git-diff-index
+ git-diff-tree
+ git-rev-list
+ git-rev-parse
+
+* In a freashly created empty repository, `git fetch foo:bar`
+ works OK, but `git checkout bar` afterwards does not (missing
+ `.git/HEAD`).
\f
Local Variables: