summaryrefslogtreecommitdiff
path: root/Documentation/git-submodule.txt
diff options
context:
space:
mode:
authorDenton Liu <liu.denton@gmail.com>2019-02-15 09:26:41 (GMT)
committerJunio C Hamano <gitster@pobox.com>2019-02-15 17:55:27 (GMT)
commit68cabbfda36b2e515802e13753637a987c4cf9a9 (patch)
tree6e350fb9571221f3c399a5f2c3c87e7040ab65d8 /Documentation/git-submodule.txt
parent2d08f3deb9feb73dc8d21d75bfd367839fc1322c (diff)
downloadgit-68cabbfda36b2e515802e13753637a987c4cf9a9.zip
git-68cabbfda36b2e515802e13753637a987c4cf9a9.tar.gz
git-68cabbfda36b2e515802e13753637a987c4cf9a9.tar.bz2
submodule: document default behavior
submodule's default behavior wasn't documented in both git-submodule.txt and in the usage text of git-submodule. Document the default behavior similar to how git-remote does it. Signed-off-by: Denton Liu <liu.denton@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-submodule.txt')
-rw-r--r--Documentation/git-submodule.txt4
1 files changed, 4 insertions, 0 deletions
diff --git a/Documentation/git-submodule.txt b/Documentation/git-submodule.txt
index ba3c4df..2794e29 100644
--- a/Documentation/git-submodule.txt
+++ b/Documentation/git-submodule.txt
@@ -9,6 +9,7 @@ git-submodule - Initialize, update or inspect submodules
SYNOPSIS
--------
[verse]
+'git submodule' [--quiet] [--cached]
'git submodule' [--quiet] add [<options>] [--] <repository> [<path>]
'git submodule' [--quiet] status [--cached] [--recursive] [--] [<path>...]
'git submodule' [--quiet] init [--] [<path>...]
@@ -28,6 +29,9 @@ For more information about submodules, see linkgit:gitsubmodules[7].
COMMANDS
--------
+With no arguments, shows the status of existing submodules. Several
+subcommands are available to perform operations on the submodules.
+
add [-b <branch>] [-f|--force] [--name <name>] [--reference <repository>] [--depth <depth>] [--] <repository> [<path>]::
Add the given repository as a submodule at the given path
to the changeset to be committed next to the current