Updates 2005-09-24
[git.git] / TODO
diff --git a/TODO b/TODO
index 04a4d17..970a1af 100644 (file)
--- a/TODO
+++ b/TODO
@@ -1,4 +1,37 @@
-What to expect after 0.99.6
+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.7, all renamed commands have symbolic links in
+   $(bindir) so that old names continue to work.  These backward
+   compatible names will not appear in documentation.  The main
+   documentation, git(7) will talk about the new names but would
+   mention their old names as historical notes.  Old environment
+   names defined in gitenv() will also be removed in this release.
+
+ - In 0.99.8, we will 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.
+
+   As a notable exception, 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.  Updating to 0.99.8 on one end
+   of the connection does not requier the other end to update at
+   the same time.
+
+   The timeframe for this is around Oct 1st.
+
+
+What to expect after 0.99.7
 ===========================
 
 This is written in a form of to-do list for me, so if I say
@@ -15,7 +48,7 @@ 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].
+  update the SubmittingPatches.
 
 * Talk about using rsync just once at the beginning when
   initializing a remote repository so that local packs do not
@@ -25,11 +58,19 @@ Documentation
 * Maybe update tutorial with a toy project that involves two or
   three developers..
 
+* Document octopus [Linus prodded me again; DONE].
+
 * Update tutorial to cover setting up repository hooks to do
   common tasks.
 
 * 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)
 -------------------
@@ -37,8 +78,7 @@ 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.]
+  [Deathmatch between Daniel's and Fredrik's ongoing.]
 
 * HPA has two projects, klibc and klibc-kbuild, that have large
   set of overlapping files in different paths (i.e. one has many
@@ -49,10 +89,6 @@ Technical (heavier)
   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
@@ -60,35 +96,47 @@ Technical (heavier)
   idea, making the set of packs in repositories everybody has
   different from each other.
 
-* 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.
+* Libification.  There are many places "run once" mentality is
+  ingrained in the management of basic data structures, which
+  need to be fixed.
+
+* Maybe a pack optimizer.
 
 * 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>
 
-Technical (milder)
-------------------
+* Look at libified GNU diff CVS seems to use.
 
-* Tool renames [STARTED].
 
-* Have Daniel's read-tree graduate from "pu" after plugging leaks.
+Technical (milder)
+------------------
 
-* Implement a merge backend using Daniel's read-tree.
+* Revisit 'git-merge'.  It probably was a mistake to "loop to
+  choose the best one", since what is best is not ill defined to
+  begin with.  This would make it a lot straightforward to
+  loosen the tree cleanliness requirements to the acceptable
+  level.
 
-* 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.
+* The recent commit walker safety patch may be too cautious and
+  appears to take forever when cloning.  This may even be
+  infinitely looping in the code lifted from the old rev-list --
+  needs to be taken a look at [DONE -- and redone very nicely by
+  Sergey].
 
 * Encourage concrete proposals to commit log message templates
   we discussed some time ago.
 
-* Bug Martin for archimport script documentation.
+* Accept patches for more portability.
+
+  * strcasestr() in mailinfo.  We may need compat/strcasestr.c;
+    this is bugging OpenBSD folks [DONE, thanks to Linus and
+    others].
 
-* More portability.  I dropped a SunOS patch on the floor by
-  somebody.
+  * Solaris portability [ONGOING, thanks to Patrick Mauritz,
+    Peter Eriksen and Sean from sympatico].
 
 * Accept patches to cause "read-tree -u" delete a directory when
   it makes it empty.
@@ -98,16 +146,20 @@ Technical (milder)
 
 * Perhaps accept patches to do undo/redo.
 
+* 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.
+
 * Maybe grok PGP signed text/plain in applymbox as well.
 
 * 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.
-
-* A tool to detect, show and prune already merged topic
-  branches.
+  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
@@ -119,25 +171,71 @@ 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.
+* 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].
+
+* Remove obsolete commands [DONE].
+
+* Option to limit rename detection for more than N paths [READY].
+
+* Option to show only status and name from diff [READY].
+
+* What to name the 'master' version between 0.99.7 and 0.99.8
+  and still not break binary distribution folks?  0.99.7z?
 
 
 Technical (trivial)
 -------------------
 
-* Perhaps "git branch -d" to delete a branch.
+* show-branch naming heads is buggy.
+
+  git show-branch --more=2
+  ! [linus] Input: check switch bitmap when matching handlers
+   * [master] Input: check switch bitmap when matching handlers
+  --
+  ++ [linus] Input: check switch bitmap when matching handlers
+  ++ [linus~1] Merge branch 'upstream' from master.kernel.org:/pub/scm/linux/kernel/git/jgarzik/libata-dev
+  ++ [linus^2] Merge /spare/repo/linux-2.6/
+
+  The last one should be linus~2 or something; linus head does
+  not have three parents!
+
+* Stop installing the old-name symlinks.
+
+* 'git add --recursive' [DONE]
+
+* 'git merge-projects'?
+
+* '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
   commands should be usable with relative directory paths:
 
-    update-cache
-    ls-files
-    diff-files
-    diff-cache
-    diff-tree
-    rev-list
-    rev-parse
+    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