Skip to content

Commit

Permalink
document submdule.$name.update=none option for gitmodules
Browse files Browse the repository at this point in the history
This option was not yet described in the gitmodules documentation. We
only described it in the 'git submodule' command documentation but
gitmodules is the more natural place to look.

A short reference in the 'git submodule' documentation should be
sufficient since the details can now be found in the documentation to
gitmodules.

Signed-off-by: Heiko Voigt <hvoigt@hvoigt.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
  • Loading branch information
Heiko Voigt authored and Junio C Hamano committed May 11, 2012
1 parent 5ad3e16 commit e6a1c43
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
7 changes: 2 additions & 5 deletions Documentation/git-submodule.txt
Original file line number Diff line number Diff line change
Expand Up @@ -140,18 +140,15 @@ update::
checkout the commit specified in the index of the containing repository.
This will make the submodules HEAD be detached unless `--rebase` or
`--merge` is specified or the key `submodule.$name.update` is set to
`rebase`, `merge` or `none`.
`rebase`, `merge` or `none`. `none` can be overriden by specifying
`--checkout`.
+
If the submodule is not yet initialized, and you just want to use the
setting as stored in .gitmodules, you can automatically initialize the
submodule with the `--init` option.
+
If `--recursive` is specified, this command will recurse into the
registered submodules, and update any nested submodules within.
+
If the configuration key `submodule.$name.update` is set to `none` the
submodule with name `$name` will not be updated by default. This can be
overriden by adding `--checkout` to the command.

summary::
Show commit summary between the given commit (defaults to HEAD) and
Expand Down
5 changes: 4 additions & 1 deletion Documentation/gitmodules.txt
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,11 @@ submodule.<name>.update::
the commit specified in the superproject. If 'merge', the commit
specified in the superproject will be merged into the current branch
in the submodule.
If 'none', the submodule with name `$name` will not be updated
by default.

This config option is overridden if 'git submodule update' is given
the '--merge' or '--rebase' options.
the '--merge', '--rebase' or '--checkout' options.

submodule.<name>.fetchRecurseSubmodules::
This option can be used to control recursive fetching of this
Expand Down

0 comments on commit e6a1c43

Please sign in to comment.