summaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorLibravatar Junio C Hamano <gitster@pobox.com>2019-03-07 09:59:57 +0900
committerLibravatar Junio C Hamano <gitster@pobox.com>2019-03-07 09:59:57 +0900
commitc388c12c927dc42b1b8eb2368d3519a846483081 (patch)
treed16319ec752b9c90a8c1da37d26fceab9e2255f1 /Documentation
parentMerge branch 'jk/unused-params' (diff)
parentsubmodule: document default behavior (diff)
downloadtgif-c388c12c927dc42b1b8eb2368d3519a846483081.tar.xz
Merge branch 'dl/doc-submodule-wo-subcommand'
Doc update. * dl/doc-submodule-wo-subcommand: submodule: document default behavior
Diffstat (limited to 'Documentation')
-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 ba3c4df550..2794e29780 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