summaryrefslogtreecommitdiffstats
path: root/git-submodule.txt
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2011-10-10 16:42:27 -0700
committerJunio C Hamano <gitster@pobox.com>2011-10-10 16:42:27 -0700
commit58700665185d6fc310aa6d6616ba3bec0105342d (patch)
tree7c36d0aadaf906e5057fecd87331d7ff52ea753d /git-submodule.txt
parent8fb66e5074d5cdeeb08e304be977374501a0787d (diff)
downloadgit-htmldocs-58700665185d6fc310aa6d6616ba3bec0105342d.tar.gz
Autogenerated HTML docs for v1.7.7-213-g8b0e1
Diffstat (limited to 'git-submodule.txt')
-rw-r--r--git-submodule.txt8
1 files changed, 7 insertions, 1 deletions
diff --git a/git-submodule.txt b/git-submodule.txt
index 67cf5f0f8..6ec3fef07 100644
--- a/git-submodule.txt
+++ b/git-submodule.txt
@@ -120,6 +120,8 @@ too (and can also report changes to a submodule's work tree).
init::
Initialize the submodules, i.e. register each submodule name
and url found in .gitmodules into .git/config.
+ It will also copy the value of `submodule.$name.update` into
+ .git/config.
The key used in .git/config is `submodule.$name.url`.
This command does not alter existing information in .git/config.
You can then customize the submodule clone URLs in .git/config
@@ -133,7 +135,7 @@ 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` or `merge`.
+ `rebase`, `merge` or `none`.
+
If the submodule is not yet initialized, and you just want to use the
setting as stored in .gitmodules, you can automatically initialize the
@@ -141,6 +143,10 @@ 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