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