TODO updates.
[git.git] / TODO
diff --git a/TODO b/TODO
index cd6c5b8..a38f6eb 100644 (file)
--- a/TODO
+++ b/TODO
-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.
+What to expect from now on
+==========================
+
+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 ;-).
 
- - 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'.
+Documentation
+-------------
 
- - 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.
+* No pending issues at the moment.  "Revamp Tutorial" initiative
+  by Bruce Fields ongoing and things are looking better.
 
- - 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.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.
+Design issues
+-------------
 
-   Tentatively we aim to do this on Sep 17th.
+* Rehash "git commit" with various parameters to be more
+  intuitive without breaking traditinal users too much.  We need
+  to phase this in, especially if we are going to change "git
+  commit" to imply the current "git commit -a" behaviour.
 
- - 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.
+* "intent to add" index entries.
 
-   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.
+* Plug-in file-level merges.  On the other hand, we may not even
+  need this; just tell people to run "xxdiff -U" on the working
+  tree files.
 
+* Doing a merge in a separate directory.
 
-Documentation
--------------
+* Make 'format-patch' take revision limiters similar to
+  rev-list.  For example:
 
-* 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.
+               A                  C
+       ....---x---o---o---x---o---o
+                          /
+                         /
+                        /
+       ....---x---o---o
+               B
 
-* Accept patches from people who were hit by shiny blue bat to
-  update the SubmittingPatches [ONGOING].
+  we should be able to format commits 'o', without duplicates,
+  by:
 
-* 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 (but see below about optimized cloning).
+       $ git format-patch ^A ^B C
 
-* Maybe update tutorial with a toy project that involves two or
-  three developers..
+  Currently the closest approximation is
 
-* Update tutorial to cover setting up repository hooks to do
-  common tasks.
+       $ git format-patch A..C B..C
 
-* Accept patches to finish missing docs.
+  which results in the last two commits including C formatted
+  twice.
 
 
 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 [Illustration of concept patch sent out,
-  untested yet].
-
-* 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.
+* 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>]
 
 * 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.
+
+  This needs a matching smart on the dumb protocol downloader.
+
 * Maybe an Emacs VC backend.
 
+* Look at libified GNU diff CVS seems to use, or libxdiff.
+  [Daniel has his own diff tool almost ready to start
+  integrating and testing]
+
 
 Technical (milder)
 ------------------
 
-* Tool renames.  Give fixup patch for at least Cogito and StGIT.
-  [As of this writing 2005-09-08 evening US/Pacific, the
-  "master" has what should go in 0.99.7 except gitenv() removal].
+* "git status -v" to give commit preview.
 
+* Subprojects.  I think the "bind commit" approach has been
+  outlined at sufficiently detailed level.  Maybe find time to
+  actually start prototyping it?
 
-* Have Daniel's read-tree graduate from "pu" after plugging leaks.
+  <7vacdzkww3.fsf@assigned-by-dhcp.cox.net>
 
-* Implement a merge backend using Daniel's read-tree.
+* Shallow clones.
 
-* 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.
+* Mark entries as "assume unchanged" in the index.
 
-* Encourage concrete proposals to commit log message templates
-  we discussed some time ago.
+  <Pine.LNX.4.64.0601311807470.7301@g5.osdl.org>
 
-* Bug Martin for archimport script documentation.
+  A config item '[core] trust_stat = false' would cause to:
 
-* More portability.
+  - "update-index" with or without --add would mark the path
+    valid after registering.  Should we make the working tree
+    file read-only at this point?
 
-* Accept patches to cause "read-tree -u" delete a directory when
-  it makes it empty.
+  - checkout-index -u would mark the path and makes the working
+    tree file read-only.
 
-* Perhaps accept patches to introduce the concept of "patch flow
-  expressed as ref mappings" Josef has been advocating about.
+  - read-tree without -u would mark the path invalid.
 
-* Perhaps accept patches to do undo/redo.
+  - update-index --refresh should *not* mark up-to-date paths valid.
 
-* Perhaps accept patch to optionally allow '--fuzz' in
-  'git-apply'.
+  Impacts to various commands:
 
-* Maybe grok PGP signed text/plain in applymbox as well.
+  - update-index --refresh would ignore them.
+
+  - diff-files would say unchanged.
+
+  - diff-index without --cached acts the same way as diff-index
+    --cached.
+
+* Decide what to do about rebase applied to merged head.  One
+  extreme is to allow rebase if "rev-list ours..theirs" gives
+  anything.  This loosens the current merge-base based approach.
+  The other extreme is to refuse rebase if "rev-list
+  theirs..ours" contains any merge commit, which was discussed
+  on the list.
+
+  <43CC695E.2020506@codeweavers.com>
 
-* 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.
+* Decide what the right thing to do upon an empty merge commit,
+  when both branches happen to have obtained the same set of
+  changes through different history.  Not recording such keeps
+  the history simpler, and the next merge would soon create a
+  true merge commit anyway, but this does not feel quite right.
 
-* A tool to detect, show and prune already merged topic
-  branches.
+  <20060114021800.4688.qmail@web31803.mail.mud.yahoo.com>
 
-* "Lost and Found"; find the minimum number of dangling commits
-  from the fsck-objects output to make everybody not dangling,
-  and link them under $GIT_DIR/refs/lost-found/.  Then
-  show-branch or gitk can be used to find any lost commit.
+* Perhaps a smarter HTTP anonymous download via CGI.
 
-  Do not name it /lost+found/; that would probably confuse
-  things that incorrectly assumes that is a mount point (not our
-  code but somebody else's).
+* 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.
 
-* Enhance "git repack" to not always use --all; this would be
-  handy if the repository contains wagging heads like "pu" in
-  git.git repository.
+* daemon --strict-symlink.
 
-* 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.
+* daemon --base-path does not apply automatically to whitelist
+  somehow feels wrong.  If somebody cares enough, accept
+  patches.
 
-* Option to limit rename detection for more than N paths.
+* Perhaps detect cloning request in upload-pack and cache the
+  result for next cloning request until any of our refs change.
 
-* 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.
+* Perhaps accept patch to optionally allow '--fuzz' in
+  'git-apply'.  am/applymbox is _not_ the place to do it.
+
+* Allow 'git apply' to accept GNU diff 2.7 output that forgets
+  to say '\No newline' if both input ends with incomplete
+  lines.
+
+* Perhaps deal with "Files differ" (binary diff) in non C
+  locales.
+
+* Maybe grok PGP signed text/plain in applymbox as well.
+
+* 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)
 -------------------
 
-* Perhaps "git branch -d" to delete a branch.
-
-* 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:
+* git-proxy should be spawned with sh -c 'command' $1 $2.
 
-    git-update-index
-    git-ls-files
-    git-diff-files
-    git-diff-index
-    git-diff-tree
-    git-rev-list
-    git-rev-parse
+* test scripts for the relative directory path stuff.
 
-* In a freashly created empty repository, `git fetch foo:bar`
+* In a freshly created empty repository, `git fetch foo:bar`
   works OK, but `git checkout bar` afterwards does not (missing
   `.git/HEAD`).