summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLibravatar Steffen Prohaska <prohaska@zib.de>2008-01-21 07:41:27 +0100
committerLibravatar Junio C Hamano <gitster@pobox.com>2008-01-21 00:57:51 -0800
commitc4a95c9f4b9c7b4dc8b705d323309263aa154e6a (patch)
treeaf065cad4344caa9d8436177309e2a613bba8d3a
parentgit-submodule: add test for the subcommand parser fix (diff)
downloadtgif-c4a95c9f4b9c7b4dc8b705d323309263aa154e6a.tar.xz
submodule: Document the details of the command line syntax
Only "status" accepts "--cached" and the preferred way of passing sub-command specific options is after the sub-command. The documentation is adapted to reflect this. Signed-off-by: Steffen Prohaska <prohaska@zib.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
-rw-r--r--Documentation/git-submodule.txt5
1 files changed, 3 insertions, 2 deletions
diff --git a/Documentation/git-submodule.txt b/Documentation/git-submodule.txt
index cffc6d48fb..e818e6e789 100644
--- a/Documentation/git-submodule.txt
+++ b/Documentation/git-submodule.txt
@@ -9,8 +9,9 @@ git-submodule - Initialize, update or inspect submodules
SYNOPSIS
--------
[verse]
-'git-submodule' [--quiet] [-b branch] add <repository> [<path>]
-'git-submodule' [--quiet] [--cached] [status|init|update] [--] [<path>...]
+'git-submodule' [--quiet] add [-b branch] [--] <repository> [<path>]
+'git-submodule' [--quiet] status [--cached] [--] [<path>...]
+'git-submodule' [--quiet] [init|update] [--] [<path>...]
COMMANDS