TODO

   1 What to expect after 0.99.6
   2 ===========================
   3
   4 This is written in a form of to-do list for me, so if I say
   5 "accept patch", it means I do not currently plan to do that
   6 myself.  People interested in seeing it materialize please take
   7 a hint.  The latest copy of this document is found at
   8
   9     http://kernel.org/git/?p=git/git.git;a=blob;hb=todo;f=TODO
  10
  11 Tool Renames Plan
  12 -----------------
  13
  14  - All non-binary commands will lose -script suffix in
  15    $(bindir).  The source to git-foo will be either git-foo.sh
  16    or git-foo.perl in the source tree, and the documentation
  17    will be in Documentation/git-foo.txt.
  18
  19  - The commands whose names have 'cache' to mean 'index file'
  20    will get 'cache' in their names replaced with 'index'. For
  21    git-fsck-cache and git-convert-cache, 'cache' will be
  22    replaced with 'objects'.
  23
  24  - The commit walkers will have 'pull' in their names replaced
  25    with 'fetch'.  'git-ssh-push' will become 'git-ssh-upload'.
  26
  27  - We continue to follow the convention to name the C source
  28    file that contains the main program of 'git-foo' command
  29    'foo.c'.  That means we will have 'fsck-objects.c', for
  30    example.
  31
  32  - At this moment, I am not planning to rename the symbols used
  33    in programs, nor any library sources.  "cache.h" will stay
  34    "cache.h", so does "read-cache.c".  "struct cache_entry"  and
  35    "ce_match_stat()" will keep their names.  We _might_ want to
  36    rename them in later rounds but not right now.
  37
  38  - In 0.99.7, all renamed commands will have symbolic links in
  39    $(bindir) so that old names continue to work.  These backward
  40    compatible symlinks will not be present in documentation,
  41    though.  Especially, the main documentation, git(7) will talk
  42    about the new names.  Old environment names defined in
  43    gitenv() will also be removed in this release.
  44
  45    Tentatively we aim to do this on Sep 17th.
  46
  47  - In 0.99.8, we do not install these backward compatible
  48    symbolic links in $(bindir) anymore.  The Makefile will have
  49    a target to remove old symlinks from $(DESTDIR)$(bindir) you
  50    can run manually to help you clean things up.
  51
  52    The timeframe for this is around Oct 1st, but I could be
  53    talked into delaying the symlink removal if Porcelain people
  54    find this schedule too tight.
  55
  56
  57 Documentation
  58 -------------
  59
  60 * Accept patches from people who actually have done CVS
  61   migration and update the cvs-migration documentation.
  62   Link the documentation from the main git.txt page.
  63
  64 * Accept patches from people who were hit by shiny blue bat to
  65   update the SubmittingPatches.
  66
  67 * Talk about using rsync just once at the beginning when
  68   initializing a remote repository so that local packs do not
  69   need to be expanded.  I personally do not think we need tool
  70   support for this (but see below about optimized cloning).
  71
  72 * Maybe update tutorial with a toy project that involves two or
  73   three developers..
  74
  75 * Update tutorial to cover setting up repository hooks to do
  76   common tasks.
  77
  78 * Accept patches to finish missing docs.
  79
  80
  81 Technical (heavier)
  82 -------------------
  83
  84 * Tony Luck reported an unfortunate glitch in the 3-way merge.
  85   Encourage discussions to come up with a not-so-expensive way
  86   to catch the kind of ambiguities that led to his misery.
  87   [Deathmatch between Daniel's and Fredrik's ongoing.]
  88
  89 * HPA has two projects, klibc and klibc-kbuild, that have large
  90   set of overlapping files in different paths (i.e. one has many
  91   renames from the other).  There currently is no way for git to
  92   help keep these two trees in sync, merging criss-cross between
  93   them.  The merge logic should be able to take advantage of
  94   rename/copy detection smarts git-diff-* family has.  Linus,
  95   me, and Daniel outlined a smarter merge strategy for this.
  96   Try them out.
  97
  98 * To make it easier to experiment with different merge
  99   strategies, make git-merge driver that will run merge backends
 100   for the best merge [DONE].
 101
 102 * Sort out the mess objects/info/alternates introduces on the
 103   client end.  Both rsync and commit walkers are broken
 104   [Daniel already started some, need to describe the current
 105   situation first.]
 106
 107 * We might want to optimize cloning with GIT native transport
 108   not to explode the pack, and store it in objects/pack instead.
 109   We would need a tool to generate an idx file out of a pack
 110   file for this.  Also this itself may turn out to be a bad
 111   idea, making the set of packs in repositories everybody has
 112   different from each other.
 113
 114 * Maybe a pack optimizer.
 115
 116 * Maybe an Emacs VC backend.
 117
 118
 119 Technical (milder)
 120 ------------------
 121
 122 * Define semantics for relative pathnames in objects/info/alternates.
 123   Either relative to 'objects', or relative to the top of project tree
 124   ;the latter is consistent with GIT_ALTERNATE_OBJECT_DIRECTORIES.
 125   Perhaps would end up doing the former because we would want to be
 126   consistent between a naked repository and a repository with working
 127   tree [DONE].
 128
 129 * Tool renames.  Give fixup patch for at least Cogito and StGIT
 130   [DONE].
 131
 132 * Massage ssh-fetch and ssh-upload to be more backward
 133   compatible.
 134
 135 * Have Daniel's read-tree graduate from "pu" after plugging
 136   leaks [DONE].
 137
 138 * Implement a merge backend using Daniel's read-tree [DONE].
 139
 140 * Rename 'git-merge-resolve' to 'git-merge-stupid' and
 141   'git-merge-multibase' to 'git-merge-resolve'; the former is
 142   for historical curiosity and comparison purposes only and not
 143   to be used in real applications so remove it from the default
 144   strategies list [DONE].
 145
 146 * Accept Fredrik merge after renaming it (I want to name the
 147   driver 'git merge').  Suggest where to place *.py stuff --
 148   probably in $(share)/git-core/ and add Makefile entry for
 149   installation [DONE].
 150
 151 * Encourage concrete proposals to commit log message templates
 152   we discussed some time ago.
 153
 154 * Bug Martin for archimport script documentation [DONE].
 155
 156 * More portability [IN PROGRESS].
 157
 158 * Accept patches to cause "read-tree -u" delete a directory when
 159   it makes it empty.
 160
 161 * Perhaps accept patches to introduce the concept of "patch flow
 162   expressed as ref mappings" Josef has been advocating about.
 163
 164 * Perhaps accept patches to do undo/redo.
 165
 166 * Perhaps accept patch to optionally allow '--fuzz' in
 167   'git-apply'.
 168
 169 * Maybe grok PGP signed text/plain in applymbox as well.
 170
 171 * Perhaps a tool to revert a single file to pre-modification
 172   state?  git-cat-file blob `git-ls-files | grep foo` >foo or
 173   git-cat-file blob `git-ls-tree HEAD foo` >foo?  What should
 174   the command be called?  git-revert is taken so is
 175   git-checkout.
 176
 177 * A tool to detect, show and prune already merged topic
 178   branches [DONE; 'branch -d' to prune; users can do gitk for
 179   deciding].
 180
 181 * "Lost and Found"; link dangling commits found by fsck-objects
 182   under $GIT_DIR/refs/lost-found/.  Then show-branch or gitk can
 183   be used to find any lost commit.
 184
 185   Do not name it /lost+found/; that would probably confuse
 186   things that mistake it a mount point (not our code but
 187   somebody else's).
 188
 189 * Enhance "git repack" to not always use --all; this would be
 190   handy if the repository contains wagging heads like "pu" in
 191   git.git repository.
 192
 193 * Internally split the project into non-doc and doc parts; add
 194   an extra root for the doc part and merge from it; move the
 195   internal doc source to a separate repository, like the +Meta
 196   repository; experiment if this results in a reasonable
 197   workflow, and document it in howto form if it does.
 198
 199 * Option to limit rename detection for more than N paths.
 200
 201 * diffcore-rename leak reintroduced because the 'fix' was
 202   broken.  Need to take a look into this.
 203
 204 * Marking copy seems to be broken when A,B => B,C rename
 205   happens; we incorrectly say B stays, which makes the new B
 206   copy of old A, not rename [DONE].
 207
 208 * Make rebase restartable; instead of skipping what cannot be
 209   automatically forward ported, leave the conflicts in the work
 210   tree, have the user resolve it, and then restart from where it
 211   left off.
 212
 213 * Output full path in the "git-rev-list --objects" output, not
 214   just the basename, and see the improved clustering results in
 215   better packing [Tried, but did not work out well].
 216
 217
 218 Technical (trivial)
 219 -------------------
 220
 221 * Deal with CDPATH [DONE].
 222
 223 * Teach 'git format-patch' about 'git cherry' [DONE].
 224
 225 * Make 'git bisect' easier to use by logging the earlier
 226   good/bad choices and make it replayable [DONE].
 227
 228 * Perhaps "git branch -d" to delete a branch.  We probably need
 229   some way to say "delete this branch because everything in this
 230   should be merged in the master branch" and refuse the removal
 231   if it is not true [DONE].
 232
 233 * We would want test scripts for the relative directory path
 234   stuff Linus has been working on.  So far, the following
 235   commands should be usable with relative directory paths:
 236
 237     git-update-index
 238     git-ls-files
 239     git-diff-files
 240     git-diff-index
 241     git-diff-tree
 242     git-rev-list
 243     git-rev-parse
 244
 245 * In a freashly created empty repository, `git fetch foo:bar`
 246   works OK, but `git checkout bar` afterwards does not (missing
 247   `.git/HEAD`).
 248
 249 \f
 250 Local Variables:
 251 mode: text
 252 End: