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   Message-ID: <Pine.LNX.4.63.0509221617300.23242@iabervon.org>
 110
 111 * Look at libified GNU diff CVS seems to use, or libxdiff.
 112
 113
 114 Technical (milder)
 115 ------------------
 116
 117 * Use 'git-update-ref' in the scripts.
 118
 119 * Use symbolic refs in .git/HEAD.  Should we do that everywhere
 120   while honoring the symlinked HEAD in the existing repositories
 121   for backward compatibility, or just only when 'ln -s' fails?
 122
 123 * Revisit 'git-merge'.  It probably was a mistake to "loop to
 124   choose the best one", since what is best is not ill defined to
 125   begin with.  This would make it a lot straightforward to
 126   loosen the tree cleanliness requirements to the acceptable
 127   level [DONE].
 128
 129 * The recent commit walker safety patch may be too cautious and
 130   appears to take forever when cloning.  This may even be
 131   infinitely looping in the code lifted from the old rev-list --
 132   needs to be taken a look at [DONE -- and redone very nicely by
 133   Sergey].
 134
 135 * Encourage concrete proposals to commit log message templates
 136   we discussed some time ago.
 137
 138 * Accept patches for more portability.
 139
 140   * strcasestr() in mailinfo.  We may need compat/strcasestr.c;
 141     this is bugging OpenBSD folks [DONE, thanks to Linus and
 142     others].
 143
 144   * Solaris portability [ONGOING, thanks to Patrick Mauritz,
 145     Peter Eriksen and Sean from sympatico].
 146
 147 * Accept patches to cause "read-tree -u" delete a directory when
 148   it makes it empty.
 149
 150 * Perhaps accept patches to introduce the concept of "patch flow
 151   expressed as ref mappings" Josef has been advocating about.
 152
 153 * Perhaps accept patches to do undo/redo.
 154
 155 * Perhaps accept patch to optionally allow '--fuzz' in
 156   'git-apply'.
 157
 158 * Allow 'git apply' to accept GNU diff 2.7 output that forgets
 159   to say '\No newline' if both input ends with incomplete
 160   lines.
 161
 162 * Maybe grok PGP signed text/plain in applymbox as well.
 163
 164 * Perhaps a tool to revert a single file to pre-modification
 165   state?  People with BK background know this operation as
 166   'clean'.  'git checkout [-f] ent [path...]' was suggested by
 167   Matthias Urlichs which sounds a natural extention to what the
 168   command currently does.
 169
 170 * Enhance "git repack" to not always use --all; this would be
 171   handy if the repository contains wagging heads like "pu" in
 172   git.git repository.
 173
 174 * Internally split the project into non-doc and doc parts; add
 175   an extra root for the doc part and merge from it; move the
 176   internal doc source to a separate repository, like the +Meta
 177   repository; experiment if this results in a reasonable
 178   workflow, and document it in howto form if it does.
 179
 180 * Make rebase restartable; instead of skipping what cannot be
 181   automatically forward ported, leave the conflicts in the work
 182   tree, have the user resolve it, and then restart from where it
 183   left off.
 184
 185 * Output full path in the "git-rev-list --objects" output, not
 186   just the basename, and see the improved clustering results in
 187   better packing [Tried, but did not work out well].
 188
 189 * Remove obsolete commands [DONE].
 190
 191 * Option to limit rename detection for more than N paths [DONE].
 192
 193 * Option to show only status and name from diff [DONE].
 194
 195 * What to name the 'master' version between 0.99.7 and 0.99.8
 196   and still not break binary distribution folks?  0.99.7z?
 197   Pasky gave me a good one: 0.99.7.GIT [DONE]
 198
 199 * Listing more than one head on the Pull: line of .git/remotes/
 200   allows you to make Octopus -- is it useful?  Probabaly not.
 201   Either adopt "only the first head is used for the merge by
 202   default if taken from .git/remotes/ file", or "list heads to
 203   merge on a separate Merge: line" proposal.  I already have the
 204   code to do the former, so...
 205
 206
 207 Technical (trivial)
 208 -------------------
 209
 210 * Usher SSL enhancements to http-fetch from Nick Hengeveld into
 211   a shape acceptable by everybody.
 212
 213 * Require tk 2.4 in the spec file.
 214
 215 * show-branch naming heads is buggy [DONE].
 216
 217 * Stop installing the old-name symlinks [DONE].
 218
 219 * 'git merge-projects'?
 220
 221 * 'git clone' does not check things out.  Should it?
 222
 223 * 'git lost-and-found'?  Link dangling commits found by
 224   fsck-objects under $GIT_DIR/refs/lost-found/.  Then
 225   show-branch or gitk can be used to find any lost commit. [A
 226   feeler patch sent out. Very underwhelming response X-<.]
 227
 228   Do not name it /lost+found/; that would probably confuse
 229   things that mistake it a mount point (not our code but
 230   somebody else's).
 231
 232 * Add simple globbing rules to git-show-branch so that I can
 233   say 'git show-branch --heads "ko-*"' (ko-master, ko-pu, and
 234   ko-rc are in refs/tags/).
 235
 236 * We would want test scripts for the relative directory path
 237   stuff Linus has been working on.  So far, the following
 238   commands should be usable with relative directory paths:
 239
 240     git-update-index
 241     git-ls-files
 242     git-diff-files
 243     git-diff-index
 244     git-diff-tree
 245     git-rev-list
 246     git-rev-parse
 247
 248 * In a freashly created empty repository, `git fetch foo:bar`
 249   works OK, but `git checkout bar` afterwards does not (missing
 250   `.git/HEAD`).
 251
 252 \f
 253 Local Variables:
 254 mode: text
 255 End: