Fix and complete synopsis of commands in documentation
Change-Id: Ie94b8ce89e75d4c5eb05ce26f41d44099221841c
Signed-off-by: Edwin Kempin <edwin.kempin@sap.com>
diff --git a/Documentation/cmd-create-group.txt b/Documentation/cmd-create-group.txt
index 8d404ec..8dc6dcc 100644
--- a/Documentation/cmd-create-group.txt
+++ b/Documentation/cmd-create-group.txt
@@ -9,8 +9,8 @@
--------
[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]
diff --git a/Documentation/cmd-create-project.txt b/Documentation/cmd-create-project.txt
index 02aa078..d0e56fd 100644
--- a/Documentation/cmd-create-project.txt
+++ b/Documentation/cmd-create-project.txt
@@ -14,7 +14,7 @@
[--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]
diff --git a/Documentation/cmd-ls-groups.txt b/Documentation/cmd-ls-groups.txt
index a50657b..306bb92 100644
--- a/Documentation/cmd-ls-groups.txt
+++ b/Documentation/cmd-ls-groups.txt
@@ -9,10 +9,11 @@
--------
[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
-----------
diff --git a/Documentation/cmd-ls-projects.txt b/Documentation/cmd-ls-projects.txt
index 25cd9a9..d7d5aa5 100644
--- a/Documentation/cmd-ls-projects.txt
+++ b/Documentation/cmd-ls-projects.txt
@@ -10,8 +10,12 @@
[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 @@
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 7e5ca09..68f686d 100644
--- a/Documentation/cmd-receive-pack.txt
+++ b/Documentation/cmd-receive-pack.txt
@@ -8,7 +8,10 @@
SYNOPSIS
--------
[verse]
-'git receive-pack' [--reviewer <address>] [--cc <address>] <project>
+'git receive-pack'
+ [--reviewer <address> | --re <address>]
+ [--cc <address>]
+ <project>
DESCRIPTION
-----------
diff --git a/Documentation/cmd-review.txt b/Documentation/cmd-review.txt
index eed6902..fdb5273 100644
--- a/Documentation/cmd-review.txt
+++ b/Documentation/cmd-review.txt
@@ -9,10 +9,10 @@
--------
[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]
diff --git a/Documentation/cmd-set-project.txt b/Documentation/cmd-set-project.txt
index c4b9b4f..059f063 100644
--- a/Documentation/cmd-set-project.txt
+++ b/Documentation/cmd-set-project.txt
@@ -10,7 +10,7 @@
[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]
diff --git a/Documentation/cmd-set-reviewers.txt b/Documentation/cmd-set-reviewers.txt
index 9e08e39..32fd35e 100644
--- a/Documentation/cmd-set-reviewers.txt
+++ b/Documentation/cmd-set-reviewers.txt
@@ -9,9 +9,9 @@
--------
[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}...
diff --git a/Documentation/cmd-show-connections.txt b/Documentation/cmd-show-connections.txt
index b5d41bd..8404a97 100644
--- a/Documentation/cmd-show-connections.txt
+++ b/Documentation/cmd-show-connections.txt
@@ -8,7 +8,7 @@
SYNOPSIS
--------
[verse]
-'ssh' -p <port> <host> 'gerrit show-connections' [-n]
+'ssh' -p <port> <host> 'gerrit show-connections' [--numeric | -n]
DESCRIPTION
-----------
