path: root/Documentation/git-submodule.txt
diff options
authorJohan Herland <>2009-08-19 01:45:24 (GMT)
committerJunio C Hamano <>2009-08-19 05:59:58 (GMT)
commit64b19ffeddda499e7380b38b43a3dee579734905 (patch)
treefb9c4e3036fdf0e8fbed34e934431a9b38201dca /Documentation/git-submodule.txt
parentb13fd5c1a2bd450cdf7b853e0c4861f361882a18 (diff)
git submodule status: Add --recursive to recurse into nested submodules
In very large and hierarchically structured projects, one may encounter nested submodules. In these situations, it is valuable to not only show status for all the submodules in the current repo (which is what is currently done by 'git submodule status'), but also to show status for all submodules at all levels (i.e. recursing into nested submodules as well). This patch teaches the new --recursive option to the 'git submodule status' command. The patch also includes documentation and selftests. Signed-off-by: Johan Herland <> Signed-off-by: Junio C Hamano <>
Diffstat (limited to 'Documentation/git-submodule.txt')
1 files changed, 5 insertions, 2 deletions
diff --git a/Documentation/git-submodule.txt b/Documentation/git-submodule.txt
index 55bbc4f..b81c830 100644
--- a/Documentation/git-submodule.txt
+++ b/Documentation/git-submodule.txt
@@ -11,7 +11,7 @@ SYNOPSIS
'git submodule' [--quiet] add [-b branch]
[--reference <repository>] [--] <repository> <path>
-'git submodule' [--quiet] status [--cached] [--] [<path>...]
+'git submodule' [--quiet] status [--cached] [--recursive] [--] [<path>...]
'git submodule' [--quiet] init [--] [<path>...]
'git submodule' [--quiet] update [--init] [-N|--no-fetch] [--rebase]
[--reference <repository>] [--merge] [--recursive] [--] [<path>...]
@@ -100,6 +100,9 @@ status::
initialized and `+` if the currently checked out submodule commit
does not match the SHA-1 found in the index of the containing
repository. This command is the default command for 'git-submodule'.
+If '--recursive' is specified, this command will recurse into nested
+submodules, and show their status as well.
Initialize the submodules, i.e. register each submodule name
@@ -216,7 +219,7 @@ OPTIONS
for linkgit:git-clone[1]'s --reference and --shared options carefully.
- This option is only valid for foreach and update commands.
+ This option is only valid for foreach, update and status 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).