Skip to content

Commit e7220c4

Browse files
stefanbellergitster
authored andcommitted
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 (82f49f2, Teach --recursive to submodule sync, 2012-10-26) a while ago, so let's document it, too. Reported-by: Per Cederqvist <[email protected]> Signed-off-by: Stefan Beller <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 2435856 commit e7220c4

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

Documentation/git-submodule.txt

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -237,6 +237,9 @@ sync::
237237
+
238238
"git submodule sync" synchronizes all submodules while
239239
"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.
240243

241244
OPTIONS
242245
-------
@@ -364,7 +367,7 @@ the submodule itself.
364367
for linkgit:git-clone[1]'s `--reference` and `--shared` options carefully.
365368

366369
--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.
368371
Traverse submodules recursively. The operation is performed not
369372
only in the submodules of the current repo, but also
370373
in any nested submodules inside those submodules (and so on).

0 commit comments

Comments
 (0)