Updates 2005-10-10
[git.git] / TODO
diff --git a/TODO b/TODO
index e0ee758..7c7f46d 100644 (file)
--- a/TODO
+++ b/TODO
@@ -1,69 +1,45 @@
-What to expect after 0.99.6
-===========================
+The GIT To-Do File
+==================
 
-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.  The latest copy of this document is found at 
+  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
------------------
-
- - All non-binary commands will lose -script suffix in
-   $(bindir).  The source to git-foo will be either git-foo.sh
-   or git-foo.perl in the source tree, and the documentation
-   will be in Documentation/git-foo.txt.
-
- - The commands whose names have 'cache' to mean 'index file'
-   will get 'cache' in their names replaced with 'index'. For
-   git-fsck-cache and git-convert-cache, 'cache' will be
-   replaced with 'objects'.
 
- - The commit walkers will have 'pull' in their names replaced
-   with 'fetch'.  'git-ssh-push' will become 'git-ssh-upload'.
-
- - We continue to follow the convention to name the C source
-   file that contains the main program of 'git-foo' command
-   'foo.c'.  That means we will have 'fsck-objects.c', for
-   example.
+Tool Renames Plan
+=================
 
- - At this moment, I am not planning to rename the symbols used
-   in programs, nor any library sources.  "cache.h" will stay
-   "cache.h", so does "read-cache.c".  "struct cache_entry"  and
-   "ce_match_stat()" will keep their names.  We _might_ want to
-   rename them in later rounds but not right now.
+ - In 0.99.8, we will still install the backward compatible
+   symbolic links in $(bindir).  These will however be removed
+   before 1.0 happens.
 
- - In 0.99.7, all renamed commands will have symbolic links in
-   $(bindir) so that old names continue to work.  These backward
-   compatible symlinks will not be present in documentation,
-   though.  Especially, the main documentation, git(7) will talk
-   about the new names.  Old environment names defined in
-   gitenv() will also be removed in this release.
+   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.
 
-   Tentatively we aim to do this on Sep 17th.
 
- - In 0.99.8, we do not install these backward compatible
-   symbolic links in $(bindir) anymore.  The Makefile will have
-   a target to remove old symlinks from $(DESTDIR)$(bindir) you
-   can run manually to help you clean things up.
+What to expect after 0.99.8
+===========================
 
-   The timeframe for this is around Oct 1st, but I could be
-   talked into delaying the symlink removal if Porcelain people
-   find this schedule too tight.
+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.  Also whatever I marked "Perhaps" do not have to happen
+if ever -- only if somebody cares enough and submits a clean
+patch, perhaps ;-).
 
 
 Documentation
 -------------
 
+* 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.
 
-* Accept patches from people who were hit by shiny blue bat to
-  update the SubmittingPatches [ONGOING].
-
 * 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
@@ -77,29 +53,16 @@ Documentation
 
 * Accept patches to finish missing docs.
 
+* 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 looks quite promising, so is the one from
-  Fredrik.]
-
-* HPA has two projects, klibc and klibc-kbuild, that have large
-  set of overlapping files in different paths (i.e. one has many
-  renames from the other).  There currently is no way for git to
-  help keep these two trees in sync, merging criss-cross between
-  them.  The merge logic should be able to take advantage of
-  rename/copy detection smarts git-diff-* family has.  Linus,
-  me, and Daniel outlined a smarter merge strategy for this.
-  Try them out.
-
-* To make it easier to experiment with different merge
-  strategies, make git-merge driver that will run merge backends
-  for the best merge [Outlined the idea; just do it].
-
 * 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
@@ -107,52 +70,105 @@ Technical (heavier)
   idea, making the set of packs in repositories everybody has
   different from each other.
 
+* 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.
 
+* '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.
+
 
 Technical (milder)
 ------------------
 
-* Tool renames.  Give fixup patch for at least Cogito and StGIT.
+* Funny tag names and curl library.
 
-* Have Daniel's read-tree graduate from "pu" after plugging leaks.
+  curl 'http://locke.catalyst.net.nz/git/moodle.git/refs/tags/MOODLE_15_MERGED **INVALID**'
 
-* Implement a merge backend using Daniel's read-tree.
+* Review the Makefile variables and exporting rules for them,
+  while looking at prefix passing by Kai Ruemmler [DONE].
 
-* Accept Fredrik merge after renaming it (I want to name the
-  driver 'git merge').  Suggest where to place *.py stuff --
-  probably in $(share)/git-core/ and add Makefile entry for
-  installation.
+* Review the 'sparce object database' change by Linus and move
+  the first phase of it to the "master" branch [DONE].
 
-* Encourage concrete proposals to commit log message templates
-  we discussed some time ago.
+* 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.
 
-* Bug Martin for archimport script documentation.
+* Perhaps accept more "want"s in upload-pack and do something
+  intelligent about it.
 
-* More portability.
+* Perhaps detect cloning request in upload-pack and cache the
+  result for next cloning request until any of our refs change.
+
+* Perhaps send less "want"s from fetch-pack.
+
+* 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.
 
-* Perhaps accept patches to introduce the concept of "patch flow
-  expressed as ref mappings" Josef has been advocating about.
-
 * Perhaps accept patches to do undo/redo.
 
-* Maybe grok PGP signed text/plain in applymbox as well.
+* Perhaps accept patch to optionally allow '--fuzz' in
+  'git-apply'.
 
-* Perhaps a tool to revert a single file to pre-modification
-  state?  git-cat-file blob `git-ls-files | grep foo` >foo or
-  git-cat-file blob `git-ls-tree HEAD foo` >foo?  What should
-  the command be called?  git-revert is taken so is
-  git-checkout.
+* Allow 'git apply' to accept GNU diff 2.7 output that forgets
+  to say '\No newline' if both input ends with incomplete
+  lines.
 
-* A tool to detect, show and prune already merged topic
-  branches.
+* What to do with TABs and LFs in pathnames without breaking GNU
+  patch?  [Discussion started.]
 
-* "Lost and Found".
+* Maybe grok PGP signed text/plain in applymbox as well.
+
+* 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.
 
 * Enhance "git repack" to not always use --all; this would be
   handy if the repository contains wagging heads like "pu" in
@@ -164,13 +180,55 @@ Technical (milder)
   repository; experiment if this results in a reasonable
   workflow, and document it in howto form if it does.
 
-* Option to limit rename detection for more than N paths.
+  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.
+
+* 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 soon enough].
+
+* An mechanism to ignore filesystem mode bits altogether.
 
 
 Technical (trivial)
 -------------------
 
-* Perhaps "git branch -d" to delete a branch.
+* 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-<.]
+
+  Do not name it /lost+found/; that would probably confuse
+  things that mistake it a mount point (not our code but
+  somebody else's).
+
+* 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