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.8, we will still install the backward compatible
  13    symbolic links in $(bindir).  These will however be removed
  14    before 1.0 happens.
  15
  16    git-ssh-push and git-ssh-pull pair is not going away within
  17    this timeframe, if ever.  Each of these old-name commands
  18    continues to invoke its old-name counterpart on the other
  19    end.
  20
  21
  22 What to expect after 0.99.8
  23 ===========================
  24
  25 This is written in a form of to-do list for me, so if I say
  26 "accept patch", it means I do not currently plan to do that
  27 myself.  People interested in seeing it materialize please take
  28 a hint.  Also whatever I marked "Perhaps" do not have to happen
  29 if ever -- only if somebody cares enough and submits a clean
  30 patch, perhaps ;-).
  31
  32
  33 Documentation
  34 -------------
  35
  36 * Document the ref naming restrictions.
  37
  38 * David Ho's report suggests whatchanged documentation should
  39   mention -m as "commonly used options".  Steal Linus'
  40   response [DONE].
  41
  42 * Help Jon Loeliger to find place in the documentation to place
  43   his drawing.
  44
  45 * Accept patches from people who actually have done CVS
  46   migration and update the cvs-migration documentation.
  47   Link the documentation from the main git.txt page.
  48
  49 * Talk about using rsync just once at the beginning when
  50   initializing a remote repository so that local packs do not
  51   need to be expanded.  I personally do not think we need tool
  52   support for this (but see below about optimized cloning).
  53
  54 * Maybe update tutorial with a toy project that involves two or
  55   three developers..
  56
  57 * Update tutorial to cover setting up repository hooks to do
  58   common tasks.
  59
  60 * Accept patches to finish missing docs.
  61
  62 * Accept patches to talk about "Whoops, it broke.  What's
  63   next?".
  64
  65 * Accept patches to make formatted tables in asciidoc to work
  66   well in both html and man pages (see git-diff(1)).
  67
  68
  69 Technical (heavier)
  70 -------------------
  71
  72 * We might want to optimize cloning with GIT native transport
  73   not to explode the pack, and store it in objects/pack instead.
  74   We would need a tool to generate an idx file out of a pack
  75   file for this.  Also this itself may turn out to be a bad
  76   idea, making the set of packs in repositories everybody has
  77   different from each other. [DONE; git-index-pack by Sergey,
  78   tweaking clone by me]
  79
  80 * Git daemon, when deployed at kernel.org, might turn out to be
  81   quite a burden, since it needs to generate customized packs
  82   every time a new request comes in.  It may be worthwhile to
  83   precompute some packs for popular sets of heads downloaders
  84   have and serve that, even if that could give more than the
  85   client asks for in some cases.  We will know about this soon
  86   enough.
  87
  88 * Libification.  There are many places "run once" mentality is
  89   ingrained in the management of basic data structures, which
  90   need to be fixed.  [Matthias Urlichs is already working on
  91   this: <pan.2005.10.03.20.48.52.132570@smurf.noris.de>; Post
  92   1.0].
  93
  94 * Maybe a pack optimizer.
  95
  96   Given a set of objects and a set of refs (probably a handful
  97   branch heads and point release tags), find a set of packs to
  98   allow reasonably minimum download for all of these classes of
  99   people: (1) somebody cloning the repository from scratch, (2)
 100   somebody who tends to follow the master branch head reasonably
 101   closely, (3) somebody who tends to follow only the point
 102   releases.
 103
 104 * Maybe an Emacs VC backend.
 105
 106 * 'git split-projects'?  This requires updated 'git-rev-list' to
 107   skip irrelevant commits.
 108   Message-ID: <Pine.LNX.4.63.0509221617300.23242@iabervon.org>
 109
 110 * Look at libified GNU diff CVS seems to use, or libxdiff.
 111   [Daniel has his own diff tool almost ready to start
 112   integrating and testing; Post 1.0]
 113
 114 * Accept patches to fetch multiple objects by HTTP in parallel.
 115   [DONE]
 116
 117 * Plug-in file-level merges [Post 1.0].
 118
 119 * Per-repository configuration mechanism [DONE by Linus].
 120
 121
 122 Technical (milder)
 123 ------------------
 124
 125 * Merlyn reports trouble with http fetch.
 126
 127 * Maybe look at Cogito and see if I can help Pasky to adjust to
 128   the later core features?  Zack Brown's "cg-seek leaving empty
 129   directories" problem is a good example of this.
 130
 131 * Look at svn importer Smurf has.  There is a small cvsimport
 132   update in his tree as well.
 133
 134 * Decide the notation of "peeling the onion" operator, and
 135   implement it in sha1_name.c.  Perhaps postfix "^{}" to mean
 136   "peel and expect anything", "^{blob}" to mean "peel and barf
 137   unless blob".  The current "^0" becomes shorthand for
 138   "^{commit}". [DONE]
 139
 140 * Quote the URL so that libcurl's metecharacter mechanism would
 141   not kick in [DONE].
 142
 143 * Review the Makefile variables and exporting rules for them,
 144   while looking at prefix passing by Kai Ruemmler [DONE].
 145
 146 * Review the 'sparse object database' change by Linus and move
 147   the first phase of it to the "master" branch [DONE].
 148
 149 * Decide on mmap().  I am inclined to just stick to mmap
 150   replacement by Johannes Schindelin and do nothing else right
 151   now, except perhaps drop the writing-back support [DONE].
 152
 153 * Revisit Santi's patch to move commit temorary files out of the
 154   working tree toplevel [DONE].
 155
 156 * More generally, review the use of temporary files again.
 157   Assuming writable $GIT_DIR is more acceptable, but the
 158   working tree toplevel may not be in a rare usage pattern.
 159
 160 * Perhaps accept more "want"s in upload-pack and do something
 161   intelligent about it.
 162
 163 * Perhaps detect cloning request in upload-pack and cache the
 164   result for next cloning request until any of our refs change.
 165
 166 * Perhaps send less "want"s from fetch-pack.
 167
 168 * Encourage concrete proposals to commit log message templates
 169   we discussed some time ago.
 170
 171 * Accept patches to cause "read-tree -u" delete a directory when
 172   it makes it empty [DONE].
 173
 174 * Perhaps accept patches to do undo/redo.
 175
 176 * Perhaps accept patch to optionally allow '--fuzz' in
 177   'git-apply'.
 178
 179 * Allow 'git apply' to accept GNU diff 2.7 output that forgets
 180   to say '\No newline' if both input ends with incomplete
 181   lines.
 182
 183 * What to do with TABs and LFs in pathnames without breaking GNU
 184   patch?  [DONE -- go with GNU patch extension proposed by Paul].
 185
 186 * Adjust apply.c to proposed GNU patch extension that quotes \n
 187   and \t in C style, inside "". [DONE]
 188
 189 * Adjust diff.c to the same. [DONE]
 190
 191 * Maybe grok PGP signed text/plain in applymbox as well.
 192
 193 * Perhaps a tool to revert a single file to pre-modification
 194   state?  People with BK background know this operation as
 195   'clean'.  'git checkout [-f] ent [path...]' was suggested by
 196   Matthias Urlichs which sounds a natural extention to what the
 197   command currently does.
 198
 199 * Enhance "git repack" to not always use --all; this would be
 200   handy if the repository contains wagging heads like "pu" in
 201   git.git repository.
 202
 203 * Internally split the project into non-doc and doc parts; add
 204   an extra root for the doc part and merge from it; move the
 205   internal doc source to a separate repository, like the +Meta
 206   repository; experiment if this results in a reasonable
 207   workflow, and document it in howto form if it does.
 208
 209   The point is to make it possible to fork that part off to
 210   somebody else; then I do not have to maintain Documentation
 211   directory myself anymore, just like I simply slurp the latest
 212   gitk from Paul and not worry about it ;-).
 213
 214 * Make rebase restartable; instead of skipping what cannot be
 215   automatically forward ported, leave the conflicts in the work
 216   tree, have the user resolve it, and then restart from where it
 217   left off [mechanism mostly done].
 218
 219 * Output full path in the "git-rev-list --objects" output, not
 220   just the basename, and see the improved clustering results in
 221   better packing [Tried, but did not work out well].
 222
 223 * Updated git-changes-script Jeff Garzik needs [Inquiry for
 224   external spec sent out with a quick hack.  Will know if that
 225   is what he needs hopefully soon].
 226
 227 * An mechanism to ignore filesystem mode bits altogether [DONE].
 228
 229
 230 Technical (trivial)
 231 -------------------
 232
 233 * Peter Hagervall's sparse fix [DONE].
 234
 235 * Alex Riesen reported that hooks are in effect in tests.
 236   Should fix [DONE].
 237
 238 * Disallow [\001-\040\177] byte values from ref names.  Also we
 239   need to disallow ':' (used in refspec), '^' and '~' (postfix
 240   "peel the onion" operators), and '..' ("ref1..ref2" notation
 241   becomes ambiguous otherwise) [DONE].
 242
 243 * Update fetch-pack and clone-pack to ignore funny refs from the
 244   other end, while making sure peek-remote does not discard them.
 245   [DONE]
 246
 247 * Update upload-pack to send tag^{}.  This would hopefully help
 248   Pasky's automated tag tracking, and also Martin's findtags.
 249   [DONE]
 250
 251 * Adjust update-index to quoted --index-info.
 252
 253 * Prepare apply.c changes for maint branch (0.99.8e).
 254
 255 * Show ^{commit}, ^{tree} instead of ^{} from ls-remote.
 256
 257 * Readjust maint branch for the above (0.99.8e).
 258
 259 * short SHA1 naming is not enforcing uniqueness.  Should fix [DONE].
 260
 261 * 'git repack' can be DOSed.  Should fix [DONE].
 262
 263 * Stop installing the old-name symlinks [POSTPONED, but before 1.0].
 264
 265 * 'git merge-projects'?
 266
 267   Subject: Re: Merges without bases
 268   References: <1125004228.4110.20.camel@localhost.localdomain>
 269   Date: Thu, 25 Aug 2005 15:26:36 -0700
 270   Message-ID: <7vvf1tps9v.fsf@assigned-by-dhcp.cox.net>
 271
 272 * 'git lost-and-found'?  Link dangling commits found by
 273   fsck-objects under $GIT_DIR/refs/lost-found/.  Then
 274   show-branch or gitk can be used to find any lost commit. [A
 275   feeler patch sent out. Very underwhelming response X-<.]
 276
 277   Do not name it /lost+found/; that would probably confuse
 278   things that mistake it a mount point (not our code but
 279   somebody else's).
 280
 281 * Add simple globbing rules to git-show-branch so that I can
 282   say 'git show-branch --heads "ko-*"' (ko-master, ko-pu, and
 283   ko-rc are in refs/tags/).
 284
 285 * We would want test scripts for the relative directory path
 286   stuff Linus has been working on.  So far, the following
 287   commands should be usable with relative directory paths:
 288
 289     git-update-index
 290     git-ls-files
 291     git-diff-files
 292     git-diff-index
 293     git-diff-tree
 294     git-rev-list
 295     git-rev-parse
 296
 297 * In a freashly created empty repository, `git fetch foo:bar`
 298   works OK, but `git checkout bar` afterwards does not (missing
 299   `.git/HEAD`).
 300
 301 \f
 302 Local Variables:
 303 mode: text
 304 End: