2005-10-26 (prepare for 0.99.9)
[git.git] / TODO
diff --git a/TODO b/TODO
index 2ed37da..15ecb59 100644 (file)
--- a/TODO
+++ b/TODO
@@ -9,47 +9,41 @@ The GIT To-Do File
 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.9, the backward compatible symbolic links in
+   $(bindir) will be removed.
 
- - 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.
+   git-ssh-push and git-ssh-pull pair is not going away if ever.
+   Each of these old-name commands continues to invoke its
+   old-name counterpart on the other end.
 
-   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
+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.
 
-* Accept patches from people who were hit by shiny blue bat to
-  update the SubmittingPatches.
-
 * 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
@@ -58,12 +52,11 @@ 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.
+* Do we still have missing docs?  If so accept patches to finish
+  them.
 
 * Accept patches to talk about "Whoops, it broke.  What's
   next?".
@@ -75,33 +68,39 @@ Documentation
 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.
-  [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
-  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.
-
 * 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 [DONE part to allow using precomputed pack, but not
+  dynamic caching part].
 
 * Libification.  There are many places "run once" mentality is
   ingrained in the management of basic data structures, which
-  need to be fixed.
+  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
@@ -109,46 +108,69 @@ Technical (heavier)
   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)
 ------------------
 
-* Use 'git-update-ref' in the scripts.
+* Merlyn reports trouble with http fetch [Hopefully solved by
+  Nick's updates].
 
-* Use symbolic refs in .git/HEAD.  Should we do that everywhere
-  while honoring the symlinked HEAD in the existing repositories
-  for backward compatibility, or just only when 'ln -s' fails?
+* 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.
 
-* 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 [DONE].
+* Perhaps detect cloning request in upload-pack and cache the
+  result for next cloning request until any of our refs change.
 
-* 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].
+* Perhaps accept more "want"s in upload-pack and do something
+  intelligent about it [Ongoing, by Johannes].
 
-* Encourage concrete proposals to commit log message templates
-  we discussed some time ago.
+* Perhaps send less "want"s from fetch-pack [DONE by JS].
 
-* Accept patches for more portability.
+* Look at svn importer Smurf has.  There is a small cvsimport
+  update in his tree as well [DONE].
 
-  * strcasestr() in mailinfo.  We may need compat/strcasestr.c;
-    this is bugging OpenBSD folks [DONE, thanks to Linus and
-    others].
+* 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]
 
-  * Solaris portability [ONGOING, thanks to Patrick Mauritz,
-    Peter Eriksen and Sean from sympatico].
+* 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].
+
+* 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].
 
-* Perhaps accept patches to introduce the concept of "patch flow
-  expressed as ref mappings" Josef has been advocating about.
+* 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.
 
@@ -159,66 +181,83 @@ Technical (milder)
   to say '\No newline' if both input ends with incomplete
   lines.
 
+* What to do with TABs and LFs in pathnames without breaking GNU
+  patch?  [DONE -- go with GNU patch extension proposed by Paul].
+
+* Adjust apply.c to proposed GNU patch extension that quotes \n
+  and \t in C style, inside "". [DONE]
+
+* Adjust diff.c to the same. [DONE]
+
 * 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.
+  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.
 
-* 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.
-
 * 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.
+  left off [mechanism mostly done].
 
 * 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].
+* 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].
 
-* Option to limit rename detection for more than N paths [DONE].
+* An mechanism to ignore filesystem mode bits altogether [DONE].
 
-* Option to show only status and name from diff [DONE].
 
-* What to name the 'master' version between 0.99.7 and 0.99.8
-  and still not break binary distribution folks?  0.99.7z?
-  Pasky gave me a good one: 0.99.7.GIT [DONE]
+Technical (trivial)
+-------------------
 
-* Listing more than one head on the Pull: line of .git/remotes/
-  allows you to make Octopus -- is it useful?  Probabaly not.
-  Either adopt "only the first head is used for the merge by
-  default if taken from .git/remotes/ file", or "list heads to
-  merge on a separate Merge: line" proposal.  I already have the
-  code to do the former, so...
+* Peter Hagervall's sparse fix [DONE].
 
+* Alex Riesen reported that hooks are in effect in tests.
+  Should fix [DONE].
 
-Technical (trivial)
--------------------
+* 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) [DONE].
+
+* Perhaps show ^{commit}, ^{tree} instead of ^{} from ls-remote? [NO]
 
-* Usher SSL enhancements to http-fetch from Nick Hengeveld into
-  a shape acceptable by everybody.
+* Re-adjust maint branch for the above if we did so. [NOT NEEDED]
 
-* Require tk 2.4 in the spec file.
+* short SHA1 naming is not enforcing uniqueness.  Should fix [DONE].
 
-* show-branch naming heads is buggy [DONE].
+* 'git repack' can be DOSed.  Should fix [DONE].
 
-* Stop installing the old-name symlinks [DONE].
+* Stop installing the old-name symlinks [IN 0.99.9].
 
 * 'git merge-projects'?
 
-* 'git clone' does not check things out.  Should it?
+  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