Home.textile

   1 *Welcome to the git-submod-enhancements wiki!*
   2
   3 As Dscho put it, submodules are the "neglected ugly duckling" of git. Time to change that ...
   4
   5 *Issues still to be tackled in this repo:*
   6
   7 * Let am, bisect, checkout, checkout-index, cherry-pick, merge, pull, read-tree, rebase, reset & stash work recursively on submodules (in progress, including the 2011 GSoC work right now ...)
   8 * Teach grep the --recursive option (in progress thanks to Chris Packham)
   9 * Add means to specify which submodules shall be populated on clone
  10 * Showing that a submodule has a HEAD not on any branch in "git status"
  11 * gitk: Add popup menu for submodules to see the detailed history of changes
  12 * Teach "git prune" the "--recurse-submodules" option (and maybe honour the same default and options "git fetch" uses)
  13 * Better support for displaying merge conflicts of submodules
  14 * git gui: Add submodule menu for adding and fetching submodules
  15 * git status should call "git diff --submodule --ignore-submodules=dirty" instead of "git submodule summary" for providing a submodule summary when configured to do so.
  16 * Add an "always-tip" mode
  17 * Other commands that could benefit from a "--recurse-submodules" option: archive, branch, clean, commit, revert, tag.
  18 * In the long run git-submodule.sh should be converted to a rather simple wrapper script around core git functionality as more and more of that is implemented in the git core.
  19
  20 *Submodule related bugs to fix*
  21
  22 * Cherry picking across submodule creation fails even if the cherry pick doesn't touch any file in the submodules path
  23 * git submodule add doesn't record the url in .git/config when the submodule path doesn't exist.
  24 * git rebase --continue won't work if the commit only contains submodule changes.
  25
  26 *Issues already solved and merged into Junio's Repo:*
  27
  28 * Since git 1.6.6:
  29 ** New --submodule option to "git diff" (many thanks to Dscho for writing the core part!)
  30 ** Display of submodule summaries instead of plain hashes in git gui and gitk
  31 * Since git 1.7.0:
  32 ** "git status" and "git diff*" show submodules with untracked or modified files in their work tree as "dirty"
  33 ** git gui: New popup menu for submodule diffs
  34 * Since git 1.7.1:
  35 ** Show the reason why working directories of submodules are dirty (untracked content and/or modified content) in superproject
  36 * Since git 1.7.2:
  37 ** Add parameters to the "--ignore-submodules" option for "git diff" and "git status" to control when a submodule is considered dirty
  38 * Since git 1.7.3:
  39 ** Add the "ignore" config option for the default behaviour of "git diff" and "git status". Both .git/config and .gitmodules are parsed for this option, the value set in .git/config. will override that from .gitmodules
  40 ** Add a global config option to control when a submodule is considered dirty (written by Dscho)
  41 ** Better support for merging of submodules (thanks to Heiko Voigt for writing that)
  42 * Since git 1.7.4:
  43 ** Recursive fetching of submodules can be enabled via command line option or configuration.
  44 * Since git 1.7.5:
  45 ** fetch runs recursively on submodules by default when new commits have been recorded for them in the superproject
  46 * Since git 1.7.7:
  47 ** git push learned the --recurse-submodules=check option which errors out when trying to push a superproject commit where the submodule changes are not pushed (part of Frederik Gustafsson's 2011 GSoC project)
  48 * Since git 1.7.7:
  49 ** The "update" option learned the value "none" which disables "submodule init" and "submodule update"
  50 ** The git directory of a newly cloned submodule is stored in the .git directory of the superproject, the submodules work tree contains only a gitfile. This is the first step towards recursive checkout, as it enables us to remove a submodule directory (part of Frederik Gustafsson's 2011 GSoC project)