2005-12-05 midnight
[git.git] / TODO
diff --git a/TODO b/TODO
index 8e0f073..d97fc7a 100644 (file)
--- a/TODO
+++ b/TODO
@@ -1,10 +1,22 @@
-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
+
+
+What to expect until and after 1.0
+==================================
 
 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 ;-).
+
+Only handful things remain until 1.0.
 
 
 Documentation
@@ -14,168 +26,127 @@ Documentation
   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.
+  support for this (but see below about optimized cloning).
 
-* Review the existing docs and see if the repository
-  organization needs to be clarified further [STILL NEEDSWORK].
-
-* 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?" [ONGOING].
 
+* Accept patches to make formatted tables in asciidoc to work
+  well in both html and man pages (see git-diff(1)).
 
-Technical (heavier)
--------------------
+* Work around multiple synopses lines in manual pages
+  (e.g. git-bisect).
 
-* 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.
+Technical (heavier)
+-------------------
 
-* 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.  [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.
 
-Technical (milder)
-------------------
+  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.
 
-* 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]
+  This needs a matching smart on the dumb protocol downloader.
+  [Definitely post 1.0].
 
-  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 an Emacs VC backend.
 
-* "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]
+* 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]
 
-* Encourage concrete proposals to commit log message templates
-  we discussed some time ago.
+* Plug-in file-level merges [Post 1.0].  On the other hand, we
+  may not even need this; just tell people to run "xxdiff -U" on
+  the working tree files.
 
-* Bug Ryan and work with him to update send-email easier to use.
-  [Resurrected it for Debian build.]
+* Ref namespace management.  Perhaps use refs/local/ suggestion
+  by Linus. [Does not seem to be high on people's priority list,
+  and not interested myself.  People can resurrect this
+  discussion if they want.]
 
-* Look at portability fixes from Jason Riedy
 
-    http://www.cs.berkeley.edu/~ejr/gits/git.git#portable 
+Technical (milder)
+------------------
 
-  [Applied.  Burned by one of them and backed out, but otherwise
-  looks OK.]
+* strip leading directory from ls-tree output, to match ls-files
+  output.
 
-* Accept patches to cause "read-tree -u" delete a directory when
-  it makes it empty.
+  I am of two minds about this one.  diff output must always be
+  -p1 format no matter where the command was started, and
+  ls-tree might be easier to use if it matched diff, not
+  ls-files.
 
-* Perhaps accept patches to introduce the concept of "patch flow
-  expressed as ref mappings" Josef has been advocating about.
+* diff stopping at the first output; qgit wants to know if this
+  tree has any A or D from the other tree and nothing else.
+  Would help internal tree-diff in rev-list as well [can be post
+  1.0].
 
-* Perhaps accept patches to do undo/redo.
+* merge-recursive needs to register conflicting paths as higher
+  stage entries in the index.  For that, it first needs to
+  construct three trees whose paths are already renamed, and
+  call 3-way read-tree.  Alternatively, update-index needs to
+  give it a way to construct higher stages [can be post 1.0, but
+  nicer to have in 1.0].
 
-* 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 ;-) ]
+* daemon --strict-symlink [can be post 1.0].
 
-* "git cherry-pick" that applies the patch an existing commit
-  introduces in its ancestry chain, possibly using the 3-way
-  merge machinery. [DONE]
+* Binary package split.  Plan laid out and discussion mostly
+  done. [RPM side done; Debian side thrown over the wall.]
 
-* Update rebase using the cherry-pick command. [DONE]
+* Perhaps detect cloning request in upload-pack and cache the
+  result for next cloning request until any of our refs change.
 
-* Redo "git revert" using 3-way merge machinery. [DONE]
+* Perhaps accept patch to optionally allow '--fuzz' in
+  'git-apply'.
 
-* A tool to detect, show and prune already merged topic
-  branches.
+* Allow 'git apply' to accept GNU diff 2.7 output that forgets
+  to say '\No newline' if both input ends with incomplete
+  lines.
 
-* Set up an automated documentation rebuilding procedure at
-  kernel.org, using update hook mechanism. [DONE]  Describe it
-  in a howto form [DONE].
+* Maybe grok PGP signed text/plain in applymbox as well.
 
 * 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].
-
-* 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].
 
 
 Technical (trivial)
 -------------------
 
-* Look at and merge Debian fixes from Tommi [Done].
-
-* Perhaps "git branch -d" to delete a branch.
-
-* Remove "git clone-dumb-http".
-
 * 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
-
-
-Initial repository Gotchas
---------------------------
-
-* `git fetch foo:bar` works OK, but `git checkout bar`
-  afterwards does not (missing `.git/HEAD`)
-  
-* `git status` does not work well when missing `.git/HEAD` [DONE].
+  stuff Linus has been working on.  Most of the C-level
+  commands should be usable with relative directory paths.
 
-* `git log` either; git-log-script uses die which does not exist
-  [DONE].
+* 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: