TODO

   1 The GIT To-Do File
   2 ==================
   3
   4   The latest copy of this document is found at
   5
   6     http://kernel.org/git/?p=git/git.git;a=blob;hb=todo;f=TODO
   7
   8
   9 Tool Renames Plan
  10 =================
  11
  12  - In 0.99.7, all renamed commands have symbolic links in
  13    $(bindir) so that old names continue to work.  These backward
  14    compatible names will not appear in documentation.  The main
  15    documentation, git(7) will talk about the new names but would
  16    mention their old names as historical notes.  Old environment
  17    names defined in gitenv() will also be removed in this release.
  18
  19  - In 0.99.8, we will not install these backward compatible
  20    symbolic links in $(bindir) anymore.  The Makefile will have
  21    a target to remove old symlinks from $(DESTDIR)$(bindir) you
  22    can run manually to help you clean things up.
  23
  24    As a notable exception, git-ssh-push and git-ssh-pull pair is
  25    not going away within this timeframe, if ever.  Each of these
  26    old-name commands continues to invoke its old-name
  27    counterpart on the other end.  Updating to 0.99.8 on one end
  28    of the connection does not requier the other end to update at
  29    the same time.
  30
  31    The timeframe for this is around Oct 1st.
  32
  33
  34 What to expect after 0.99.7
  35 ===========================
  36
  37 This is written in a form of to-do list for me, so if I say
  38 "accept patch", it means I do not currently plan to do that
  39 myself.  People interested in seeing it materialize please take
  40 a hint.
  41
  42
  43 Documentation
  44 -------------
  45
  46 * Accept patches from people who actually have done CVS
  47   migration and update the cvs-migration documentation.
  48   Link the documentation from the main git.txt page.
  49
  50 * Accept patches from people who were hit by shiny blue bat to
  51   update the SubmittingPatches.
  52
  53 * Talk about using rsync just once at the beginning when
  54   initializing a remote repository so that local packs do not
  55   need to be expanded.  I personally do not think we need tool
  56   support for this (but see below about optimized cloning).
  57
  58 * Maybe update tutorial with a toy project that involves two or
  59   three developers..
  60
  61 * Document octopus [Linus prodded me again; DONE].
  62
  63 * Update tutorial to cover setting up repository hooks to do
  64   common tasks.
  65
  66 * Accept patches to finish missing docs.
  67
  68 * Accept patches to talk about "Whoops, it broke.  What's
  69   next?".
  70
  71 * Accept patches to make formatted tables in asciidoc to work
  72   well in both html and man pages (see git-diff(1)).
  73
  74
  75 Technical (heavier)
  76 -------------------
  77
  78 * Tony Luck reported an unfortunate glitch in the 3-way merge.
  79   Encourage discussions to come up with a not-so-expensive way
  80   to catch the kind of ambiguities that led to his misery.
  81   [Deathmatch between Daniel's and Fredrik's ongoing.]
  82
  83 * HPA has two projects, klibc and klibc-kbuild, that have large
  84   set of overlapping files in different paths (i.e. one has many
  85   renames from the other).  There currently is no way for git to
  86   help keep these two trees in sync, merging criss-cross between
  87   them.  The merge logic should be able to take advantage of
  88   rename/copy detection smarts git-diff-* family has.  Linus,
  89   me, and Daniel outlined a smarter merge strategy for this.
  90   Try them out.
  91
  92 * We might want to optimize cloning with GIT native transport
  93   not to explode the pack, and store it in objects/pack instead.
  94   We would need a tool to generate an idx file out of a pack
  95   file for this.  Also this itself may turn out to be a bad
  96   idea, making the set of packs in repositories everybody has
  97   different from each other.
  98
  99 * Libification.  There are many places "run once" mentality is
 100   ingrained in the management of basic data structures, which
 101   need to be fixed.
 102
 103 * Maybe a pack optimizer.
 104
 105 * Maybe an Emacs VC backend.
 106
 107 * 'git split-projects'?  This requires updated 'git-rev-list' to
 108   skip irrelevant commits.
 109
 110
 111 Technical (milder)
 112 ------------------
 113
 114 * Revisit 'git-merge'.  It probably was a mistake to "loop to
 115   choose the best one", since what is best is not ill defined to
 116   begin with.  This would make it a lot straightforward to
 117   loosen the tree cleanliness requirements to the acceptable
 118   level.
 119
 120 * The recent commit walker safety patch may be too cautious and
 121   appears to take forever when cloning.  This may even be
 122   infinitely looping in the code lifted from the old rev-list --
 123   needs to be taken a look at [DONE -- and redone very nicely by
 124   Sergey].
 125
 126 * Encourage concrete proposals to commit log message templates
 127   we discussed some time ago.
 128
 129 * Accept patches for more portability.
 130
 131   * strcasestr() in mailinfo.  We may need compat/strcasestr.c;
 132     this is bugging OpenBSD folks [DONE].
 133
 134 * Accept patches to cause "read-tree -u" delete a directory when
 135   it makes it empty.
 136
 137 * Perhaps accept patches to introduce the concept of "patch flow
 138   expressed as ref mappings" Josef has been advocating about.
 139
 140 * Perhaps accept patches to do undo/redo.
 141
 142 * Perhaps accept patch to optionally allow '--fuzz' in
 143   'git-apply'.
 144
 145 * Allow 'git apply' to accept GNU diff 2.7 output that forgets
 146   to say '\No newline' if both input ends with incomplete
 147   lines.
 148
 149 * Maybe grok PGP signed text/plain in applymbox as well.
 150
 151 * Perhaps a tool to revert a single file to pre-modification
 152   state?  People with BK background know this operation as
 153   'clean'.  'git checkout [-f] ent [path...]' was suggested by
 154   Matthias Urlichs which sounds a natural extention to what the
 155   command currently does.
 156
 157 * Enhance "git repack" to not always use --all; this would be
 158   handy if the repository contains wagging heads like "pu" in
 159   git.git repository.
 160
 161 * Internally split the project into non-doc and doc parts; add
 162   an extra root for the doc part and merge from it; move the
 163   internal doc source to a separate repository, like the +Meta
 164   repository; experiment if this results in a reasonable
 165   workflow, and document it in howto form if it does.
 166
 167 * Make rebase restartable; instead of skipping what cannot be
 168   automatically forward ported, leave the conflicts in the work
 169   tree, have the user resolve it, and then restart from where it
 170   left off.
 171
 172 * Output full path in the "git-rev-list --objects" output, not
 173   just the basename, and see the improved clustering results in
 174   better packing [Tried, but did not work out well].
 175
 176 * Remove obsolete commands [DONE].
 177
 178 * Option to limit rename detection for more than N paths [READY].
 179
 180 * Option to show only status and name from diff [READY].
 181
 182
 183 Technical (trivial)
 184 -------------------
 185
 186 * Stop installing the old-name symlinks.
 187
 188 * 'git add --recursive' [DONE]
 189
 190 * 'git merge-projects'?
 191
 192 * 'git lost-and-found'?  Link dangling commits found by
 193   fsck-objects under $GIT_DIR/refs/lost-found/.  Then
 194   show-branch or gitk can be used to find any lost commit. [A
 195   feeler patch sent out. Very underwhelming response X-<.]
 196
 197   Do not name it /lost+found/; that would probably confuse
 198   things that mistake it a mount point (not our code but
 199   somebody else's).
 200
 201 * Add simple globbing rules to git-show-branch so that I can
 202   say 'git show-branch --heads "ko-*"' (ko-master, ko-pu, and
 203   ko-rc are in refs/tags/).
 204
 205 * We would want test scripts for the relative directory path
 206   stuff Linus has been working on.  So far, the following
 207   commands should be usable with relative directory paths:
 208
 209     git-update-index
 210     git-ls-files
 211     git-diff-files
 212     git-diff-index
 213     git-diff-tree
 214     git-rev-list
 215     git-rev-parse
 216
 217 * In a freashly created empty repository, `git fetch foo:bar`
 218   works OK, but `git checkout bar` afterwards does not (missing
 219   `.git/HEAD`).
 220
 221 \f
 222 Local Variables:
 223 mode: text
 224 End: