From 73b269860954e0d77d1179fecd4eb9cbcc52c5d9 Mon Sep 17 00:00:00 2001 From: Edwin Kempin Date: Mon, 16 Jul 2012 13:53:22 +0200 Subject: [PATCH] Fix and complete synopsis of commands in documentation Change-Id: Ie94b8ce89e75d4c5eb05ce26f41d44099221841c Signed-off-by: Edwin Kempin --- Documentation/cmd-create-group.txt | 4 ++-- Documentation/cmd-create-project.txt | 2 +- Documentation/cmd-ls-groups.txt | 7 ++++--- Documentation/cmd-ls-projects.txt | 8 ++++++-- Documentation/cmd-receive-pack.txt | 5 ++++- Documentation/cmd-review.txt | 6 +++--- Documentation/cmd-set-project.txt | 2 +- Documentation/cmd-set-reviewers.txt | 6 +++--- Documentation/cmd-show-connections.txt | 2 +- 9 files changed, 25 insertions(+), 17 deletions(-) diff --git a/Documentation/cmd-create-group.txt b/Documentation/cmd-create-group.txt index 8d404ec0a8..8dc6dccb6e 100644 --- a/Documentation/cmd-create-group.txt +++ b/Documentation/cmd-create-group.txt @@ -9,8 +9,8 @@ SYNOPSIS -------- [verse] 'ssh' -p 'gerrit create-group' - [--owner ] - [--description ] + [--owner | -o ] + [--description | -d ] [--member ] [--group ] [--visible-to-all] diff --git a/Documentation/cmd-create-project.txt b/Documentation/cmd-create-project.txt index 02aa078835..d0e56fd714 100644 --- a/Documentation/cmd-create-project.txt +++ b/Documentation/cmd-create-project.txt @@ -14,7 +14,7 @@ SYNOPSIS [--suggest-parents | -S ] [--permissions-only] [--description | -d ] - [--submit-type | -t ] + [--submit-type | -t ] [--use-contributor-agreements | --ca] [--use-signed-off-by | --so] [--use-content-merge] diff --git a/Documentation/cmd-ls-groups.txt b/Documentation/cmd-ls-groups.txt index a50657bfff..306bb92e18 100644 --- a/Documentation/cmd-ls-groups.txt +++ b/Documentation/cmd-ls-groups.txt @@ -9,10 +9,11 @@ SYNOPSIS -------- [verse] 'ssh' -p 'gerrit ls-groups' - [--project ] - [--user ] + [--project | -p ] + [--user | -u ] [--visible-to-all] - [--type {internal | ldap | system}] + [--type {internal | system}] + [--verbose | -v] DESCRIPTION ----------- diff --git a/Documentation/cmd-ls-projects.txt b/Documentation/cmd-ls-projects.txt index 25cd9a9102..d7d5aa59d1 100644 --- a/Documentation/cmd-ls-projects.txt +++ b/Documentation/cmd-ls-projects.txt @@ -10,8 +10,12 @@ SYNOPSIS [verse] 'ssh' -p 'gerrit ls-projects' [--show-branch ...] - [--tree] + [--description | -d] + [--tree | -t] [--type {code | permissions | all}] + [--format {text | json | json_compact}] + [--all] + [--limit ] DESCRIPTION ----------- @@ -42,7 +46,7 @@ OPTIONS whole project is not shown. --description:: ---d:: +-d:: Allows listing of projects together with their respective description. + diff --git a/Documentation/cmd-receive-pack.txt b/Documentation/cmd-receive-pack.txt index 7e5ca09b2e..68f686d859 100644 --- a/Documentation/cmd-receive-pack.txt +++ b/Documentation/cmd-receive-pack.txt @@ -8,7 +8,10 @@ git-receive-pack - Receive what is pushed into the repository SYNOPSIS -------- [verse] -'git receive-pack' [--reviewer
] [--cc
] +'git receive-pack' + [--reviewer
| --re
] + [--cc
] + DESCRIPTION ----------- diff --git a/Documentation/cmd-review.txt b/Documentation/cmd-review.txt index eed690240f..fdb52731e0 100644 --- a/Documentation/cmd-review.txt +++ b/Documentation/cmd-review.txt @@ -9,10 +9,10 @@ SYNOPSIS -------- [verse] 'ssh' -p 'gerrit review' - [--project ] - [--message ] + [--project | -p ] + [--message | -m ] [--force-message] - [--submit] + [--submit | -s] [--abandon | --restore] [--publish] [--delete] diff --git a/Documentation/cmd-set-project.txt b/Documentation/cmd-set-project.txt index c4b9b4f960..059f063619 100644 --- a/Documentation/cmd-set-project.txt +++ b/Documentation/cmd-set-project.txt @@ -10,7 +10,7 @@ SYNOPSIS [verse] 'ssh' -p 'gerrit set-project' [--description | -d ] - [--submit-type | -t ] + [--submit-type | -t ] [--use|no-contributor-agreements | --ca|nca] [--use|no-signed-off-by | --so|nso] [--use|no-content-merge] diff --git a/Documentation/cmd-set-reviewers.txt b/Documentation/cmd-set-reviewers.txt index 9e08e39efa..32fd35e63a 100644 --- a/Documentation/cmd-set-reviewers.txt +++ b/Documentation/cmd-set-reviewers.txt @@ -9,9 +9,9 @@ SYNOPSIS -------- [verse] 'ssh' -p 'gerrit set-reviewers' - [--project ] - [--add REVIEWER ...] - [--remove REVIEWER ...] + [--project | -p ] + [--add ... | -a ...] + [--remove ... | -r ...] [--] {COMMIT | CHANGE-ID}... diff --git a/Documentation/cmd-show-connections.txt b/Documentation/cmd-show-connections.txt index b5d41bd7b6..8404a97c6d 100644 --- a/Documentation/cmd-show-connections.txt +++ b/Documentation/cmd-show-connections.txt @@ -8,7 +8,7 @@ gerrit show-connections - Display active client SSH connections SYNOPSIS -------- [verse] -'ssh' -p 'gerrit show-connections' [-n] +'ssh' -p 'gerrit show-connections' [--numeric | -n] DESCRIPTION -----------