document submdule.$name.update=none option for gitmodules
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>
Heiko Voigt committed
May 10, 2012 at 20:59 UTC
e6a1c43aafa8b221e05e57132549dcb3cd7866cf
2 files changed
+6
-6
Documentation/git-submodule.txt
+2
-5
@@ -140,7 +140,8 @@ update::
140
checkout the commit specified in the index of the containing repository.
141
This will make the submodules HEAD be detached unless `--rebase` or
142
`--merge` is specified or the key `submodule.$name.update` is set to
143
- `rebase`, `merge` or `none`.
143
+ `rebase`, `merge` or `none`. `none` can be overriden by specifying
144
+ `--checkout`.
145
+
146
If the submodule is not yet initialized, and you just want to use the
147
setting as stored in .gitmodules, you can automatically initialize the
@@ -148,10 +149,6 @@ submodule with the `--init` option.
149
+
150
If `--recursive` is specified, this command will recurse into the
151
registered submodules, and update any nested submodules within.
151
-+
152
-If the configuration key `submodule.$name.update` is set to `none` the
153
-submodule with name `$name` will not be updated by default. This can be
154
-overriden by adding `--checkout` to the command.
152
153
summary::
154
Show commit summary between the given commit (defaults to HEAD) and
Documentation/gitmodules.txt
+4
-1
@@ -41,8 +41,11 @@ submodule.<name>.update::
41
the commit specified in the superproject. If 'merge', the commit
42
specified in the superproject will be merged into the current branch
43
in the submodule.
44
+ If 'none', the submodule with name `$name` will not be updated
45
+ by default.
46
+
47
This config option is overridden if 'git submodule update' is given
45
- the '--merge' or '--rebase' options.
48
+ the '--merge', '--rebase' or '--checkout' options.
49
50
submodule.<name>.fetchRecurseSubmodules::
51
This option can be used to control recursive fetching of this