diff options
| author |  Denton Liu <liu.denton@gmail.com> | 2019-02-15 01:26:41 -0800 |
|---|---|---|
| committer |  Junio C Hamano <gitster@pobox.com> | 2019-02-15 09:55:27 -0800 |
| commit | 68cabbfda36b2e515802e13753637a987c4cf9a9 (patch) | |
| tree | 6e350fb9571221f3c399a5f2c3c87e7040ab65d8 /Documentation | |
| parent | Merge branch 'ea/rebase-compat-doc-fix' (diff) | |
| download | tgif-68cabbfda36b2e515802e13753637a987c4cf9a9.tar.xz | |
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')
| -rw-r--r-- | Documentation/git-submodule.txt | 4 |
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 |