summaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorLibravatar Tim Henigan <tim.henigan@gmail.com>2009-11-20 18:43:13 -0500
committerLibravatar Junio C Hamano <gitster@pobox.com>2009-11-20 22:15:30 -0800
commit4504107d5ef6a8840aaf278e63722bf4efbf722e (patch)
treec1d8a3f2c2d6e34cb6a79913466fb624797c3faf /Documentation
parentGIT 1.6.5 (diff)
downloadtgif-4504107d5ef6a8840aaf278e63722bf4efbf722e.tar.xz
git remote: Separate usage strings for subcommands
When the usage string for a subcommand must be printed, only print the information relevant to that command. This commit also removes the complete options list from the first line of the subcommand usage string. Instead, individual options are documented in the detailed description following the general usage line. Signed-off-by: Tim Henigan <tim.henigan@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/git-remote.txt7
1 files changed, 4 insertions, 3 deletions
diff --git a/Documentation/git-remote.txt b/Documentation/git-remote.txt
index 82a3d29673..c272c92d4b 100644
--- a/Documentation/git-remote.txt
+++ b/Documentation/git-remote.txt
@@ -13,10 +13,10 @@ SYNOPSIS
'git remote add' [-t <branch>] [-m <master>] [-f] [--mirror] <name> <url>
'git remote rename' <old> <new>
'git remote rm' <name>
-'git remote set-head' <name> [-a | -d | <branch>]
-'git remote show' [-n] <name>
+'git remote set-head' <name> (-a | -d | <branch>)
+'git remote' [-v | --verbose] 'show' [-n] <name>
'git remote prune' [-n | --dry-run] <name>
-'git remote update' [-p | --prune] [group | remote]...
+'git remote' [-v | --verbose] 'update' [-p | --prune] [group | remote]...
DESCRIPTION
-----------
@@ -30,6 +30,7 @@ OPTIONS
-v::
--verbose::
Be a little more verbose and show remote url after name.
+ NOTE: This must be placed between `remote` and `subcommand`.
COMMANDS