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>
Stefan Beller committed
Dec 3, 2015 at 12:41 UTC
e7220c40b175561a276285e95f3fe8c7a86204f2
1 file changed
+4
-1
Documentation/git-submodule.txt
+4
-1
@@ -237,6 +237,9 @@ sync::
237
+
238
"git submodule sync" synchronizes all submodules while
239
"git submodule sync \-- A" synchronizes submodule "A" only.
240
++
241
+If `--recursive` is specified, this command will recurse into the
242
+registered submodules, and sync any nested submodules within.
243
244
OPTIONS
245
-------
@@ -364,7 +367,7 @@ the submodule itself.
367
for linkgit:git-clone[1]'s `--reference` and `--shared` options carefully.
368
369
--recursive::
367
- This option is only valid for foreach, update and status commands.
370
+ This option is only valid for foreach, update, status and sync commands.
371
Traverse submodules recursively. The operation is performed not
372
only in the submodules of the current repo, but also
373
in any nested submodules inside those submodules (and so on).