Fix and complete synopsis of commands in documentation

Change-Id: Ie94b8ce89e75d4c5eb05ce26f41d44099221841c
Signed-off-by: Edwin Kempin <edwin.kempin@sap.com>
This commit is contained in:
Edwin Kempin
2012-07-16 13:53:22 +02:00
parent 0d26889a45
commit 73b2698609
9 changed files with 25 additions and 17 deletions

View File

@@ -9,8 +9,8 @@ SYNOPSIS
--------
[verse]
'ssh' -p <port> <host> 'gerrit create-group'
[--owner <GROUP>]
[--description <DESC>]
[--owner <GROUP> | -o <GROUP>]
[--description <DESC> | -d <DESC>]
[--member <USERNAME>]
[--group <GROUP>]
[--visible-to-all]

View File

@@ -14,7 +14,7 @@ SYNOPSIS
[--suggest-parents | -S ]
[--permissions-only]
[--description <DESC> | -d <DESC>]
[--submit-type <TYPE> | -t <TYPE>]
[--submit-type <TYPE> | -t <TYPE>]
[--use-contributor-agreements | --ca]
[--use-signed-off-by | --so]
[--use-content-merge]

View File

@@ -9,10 +9,11 @@ SYNOPSIS
--------
[verse]
'ssh' -p <port> <host> 'gerrit ls-groups'
[--project <NAME>]
[--user <NAME>]
[--project <NAME> | -p <NAME>]
[--user <NAME> | -u <NAME>]
[--visible-to-all]
[--type {internal | ldap | system}]
[--type {internal | system}]
[--verbose | -v]
DESCRIPTION
-----------

View File

@@ -10,8 +10,12 @@ SYNOPSIS
[verse]
'ssh' -p <port> <host> 'gerrit ls-projects'
[--show-branch <BRANCH> ...]
[--tree]
[--description | -d]
[--tree | -t]
[--type {code | permissions | all}]
[--format {text | json | json_compact}]
[--all]
[--limit <N>]
DESCRIPTION
-----------
@@ -42,7 +46,7 @@ OPTIONS
whole project is not shown.
--description::
--d::
-d::
Allows listing of projects together with their respective
description.
+

View File

@@ -8,7 +8,10 @@ git-receive-pack - Receive what is pushed into the repository
SYNOPSIS
--------
[verse]
'git receive-pack' [--reviewer <address>] [--cc <address>] <project>
'git receive-pack'
[--reviewer <address> | --re <address>]
[--cc <address>]
<project>
DESCRIPTION
-----------

View File

@@ -9,10 +9,10 @@ SYNOPSIS
--------
[verse]
'ssh' -p <port> <host> 'gerrit review'
[--project <PROJECT>]
[--message <MESSAGE>]
[--project <PROJECT> | -p <PROJECT>]
[--message <MESSAGE> | -m <MESSAGE>]
[--force-message]
[--submit]
[--submit | -s]
[--abandon | --restore]
[--publish]
[--delete]

View File

@@ -10,7 +10,7 @@ SYNOPSIS
[verse]
'ssh' -p <port> <host> 'gerrit set-project'
[--description <DESC> | -d <DESC>]
[--submit-type <TYPE> | -t <TYPE>]
[--submit-type <TYPE> | -t <TYPE>]
[--use|no-contributor-agreements | --ca|nca]
[--use|no-signed-off-by | --so|nso]
[--use|no-content-merge]

View File

@@ -9,9 +9,9 @@ SYNOPSIS
--------
[verse]
'ssh' -p <port> <host> 'gerrit set-reviewers'
[--project <PROJECT>]
[--add REVIEWER ...]
[--remove REVIEWER ...]
[--project <PROJECT> | -p <PROJECT>]
[--add <REVIEWER> ... | -a <REVIEWER> ...]
[--remove <REVIEWER> ... | -r <REVIEWER> ...]
[--]
{COMMIT | CHANGE-ID}...

View File

@@ -8,7 +8,7 @@ gerrit show-connections - Display active client SSH connections
SYNOPSIS
--------
[verse]
'ssh' -p <port> <host> 'gerrit show-connections' [-n]
'ssh' -p <port> <host> 'gerrit show-connections' [--numeric | -n]
DESCRIPTION
-----------