summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2019-03-07 00:59:57 (GMT)
committerJunio C Hamano <gitster@pobox.com>2019-03-07 00:59:57 (GMT)
commitc388c12c927dc42b1b8eb2368d3519a846483081 (patch)
treed16319ec752b9c90a8c1da37d26fceab9e2255f1
parent1dc2f8c122cfa7f8774db1395fad1873f7ad3aa8 (diff)
parent68cabbfda36b2e515802e13753637a987c4cf9a9 (diff)
downloadgit-c388c12c927dc42b1b8eb2368d3519a846483081.zip
git-c388c12c927dc42b1b8eb2368d3519a846483081.tar.gz
git-c388c12c927dc42b1b8eb2368d3519a846483081.tar.bz2
Merge branch 'dl/doc-submodule-wo-subcommand'
Doc update. * dl/doc-submodule-wo-subcommand: submodule: document default behavior
-rw-r--r--Documentation/git-submodule.txt4
-rwxr-xr-xgit-submodule.sh3
2 files changed, 6 insertions, 1 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
diff --git a/git-submodule.sh b/git-submodule.sh
index b5f2bee..514ede2 100755
--- a/git-submodule.sh
+++ b/git-submodule.sh
@@ -5,7 +5,8 @@
# Copyright (c) 2007 Lars Hjemli
dashless=$(basename "$0" | sed -e 's/-/ /')
-USAGE="[--quiet] add [-b <branch>] [-f|--force] [--name <name>] [--reference <repository>] [--] <repository> [<path>]
+USAGE="[--quiet] [--cached]
+ or: $dashless [--quiet] add [-b <branch>] [-f|--force] [--name <name>] [--reference <repository>] [--] <repository> [<path>]
or: $dashless [--quiet] status [--cached] [--recursive] [--] [<path>...]
or: $dashless [--quiet] init [--] [<path>...]
or: $dashless [--quiet] deinit [-f|--force] (--all| [--] <path>...)