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 [ONGOING].
  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   [Daniel's patch looks quite promising, so is the one from
  88   Fredrik.]
  89
  90 * HPA has two projects, klibc and klibc-kbuild, that have large
  91   set of overlapping files in different paths (i.e. one has many
  92   renames from the other).  There currently is no way for git to
  93   help keep these two trees in sync, merging criss-cross between
  94   them.  The merge logic should be able to take advantage of
  95   rename/copy detection smarts git-diff-* family has.  Linus,
  96   me, and Daniel outlined a smarter merge strategy for this.
  97   Try them out.
  98
  99 * To make it easier to experiment with different merge
 100   strategies, make git-merge driver that will run merge backends
 101   for the best merge [Outlined the idea; just do it].
 102
 103 * We might want to optimize cloning with GIT native transport
 104   not to explode the pack, and store it in objects/pack instead.
 105   We would need a tool to generate an idx file out of a pack
 106   file for this.  Also this itself may turn out to be a bad
 107   idea, making the set of packs in repositories everybody has
 108   different from each other.
 109
 110 * Maybe a pack optimizer.
 111
 112 * Maybe an Emacs VC backend.
 113
 114
 115 Technical (milder)
 116 ------------------
 117
 118 * Tool renames.  Give fixup patch for at least Cogito and StGIT.
 119
 120 * Have Daniel's read-tree graduate from "pu" after plugging leaks.
 121
 122 * Implement a merge backend using Daniel's read-tree.
 123
 124 * Accept Fredrik merge after renaming it (I want to name the
 125   driver 'git merge').  Suggest where to place *.py stuff --
 126   probably in $(share)/git-core/ and add Makefile entry for
 127   installation.
 128
 129 * Encourage concrete proposals to commit log message templates
 130   we discussed some time ago.
 131
 132 * Bug Martin for archimport script documentation.
 133
 134 * More portability.
 135
 136 * Accept patches to cause "read-tree -u" delete a directory when
 137   it makes it empty.
 138
 139 * Perhaps accept patches to introduce the concept of "patch flow
 140   expressed as ref mappings" Josef has been advocating about.
 141
 142 * Perhaps accept patches to do undo/redo.
 143
 144 * Maybe grok PGP signed text/plain in applymbox as well.
 145
 146 * Perhaps a tool to revert a single file to pre-modification
 147   state?  git-cat-file blob `git-ls-files | grep foo` >foo or
 148   git-cat-file blob `git-ls-tree HEAD foo` >foo?  What should
 149   the command be called?  git-revert is taken so is
 150   git-checkout.
 151
 152 * A tool to detect, show and prune already merged topic
 153   branches.
 154
 155 * "Lost and Found".
 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 * Option to limit rename detection for more than N paths.
 168
 169
 170 Technical (trivial)
 171 -------------------
 172
 173 * Perhaps "git branch -d" to delete a branch.
 174
 175 * We would want test scripts for the relative directory path
 176   stuff Linus has been working on.  So far, the following
 177   commands should be usable with relative directory paths:
 178
 179     git-update-index
 180     git-ls-files
 181     git-diff-files
 182     git-diff-index
 183     git-diff-tree
 184     git-rev-list
 185     git-rev-parse
 186
 187 * In a freashly created empty repository, `git fetch foo:bar`
 188   works OK, but `git checkout bar` afterwards does not (missing
 189   `.git/HEAD`).
 190
 191 \f
 192 Local Variables:
 193 mode: text
 194 End: