diff options
| author |  Stefan Beller <sbeller@google.com> | 2015-12-03 12:41:02 -0800 |
|---|---|---|
| committer |  Junio C Hamano <gitster@pobox.com> | 2015-12-04 13:08:05 -0800 |
| commit | e7220c40b175561a276285e95f3fe8c7a86204f2 (patch) | |
| tree | 4268a16c269792610b22f3358c15533b5648110b | |
| parent | Git 2.5.4 (diff) | |
| download | tgif-e7220c40b175561a276285e95f3fe8c7a86204f2.tar.xz | |
document submodule sync --recursive
The git-submodule(1) is inconsistent. In the synopsis, it says:
git submodule [--quiet] sync [--recursive] [--] [<path>...]
The description of the sync does not mention --recursive, and the
description of --recursive says that it is only available for foreach,
update and status.
The option was introduced (82f49f294c, Teach --recursive to submodule
sync, 2012-10-26) a while ago, so let's document it, too.
Reported-by: Per Cederqvist <cederp@opera.com>
Signed-off-by: Stefan Beller <sbeller@google.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
| -rw-r--r-- | Documentation/git-submodule.txt | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/Documentation/git-submodule.txt b/Documentation/git-submodule.txt index f17687e09d..1572f058f5 100644 --- a/Documentation/git-submodule.txt +++ b/Documentation/git-submodule.txt @@ -237,6 +237,9 @@ sync:: + "git submodule sync" synchronizes all submodules while "git submodule sync \-- A" synchronizes submodule "A" only. ++ +If `--recursive` is specified, this command will recurse into the +registered submodules, and sync any nested submodules within. OPTIONS ------- @@ -364,7 +367,7 @@ the submodule itself. for linkgit:git-clone[1]'s `--reference` and `--shared` options carefully. --recursive:: - This option is only valid for foreach, update and status commands. + This option is only valid for foreach, update, status and sync commands. Traverse submodules recursively. The operation is performed not only in the submodules of the current repo, but also in any nested submodules inside those submodules (and so on). |