[PATCH] document submodule sync --recursive
From: Stefan Beller <hidden>
Date: 2016-06-15 23:07:22
Subsystem:
documentation, the rest · Maintainers:
Jonathan Corbet, Linus Torvalds
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 appears to work, so the documentation should be
updated.
Tested-by: Per Cederqvist <redacted>
Signed-off-by: Stefan Beller <redacted>
---
This applies on origin/master.
Thanks Per for reporting,
Stefan
Documentation/git-submodule.txt | 5 ++++-
1 file changed, 4 insertions(+), 1 deletion(-)
diff --git a/Documentation/git-submodule.txt b/Documentation/git-submodule.txt
index f17687e..cd8d126 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 update 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).
--
2.6.1.255.gcc3df29.dirty