From e2d76a1c23abee2dd83348ca0935ae69de715b91 Mon Sep 17 00:00:00 2001 From: Michael Ochmann Date: Thu, 23 Jun 2016 17:07:37 +0200 Subject: [PATCH] Fix broken synopsis formatting in documentation Most of the cmd-xxxx.txt pages were still using the legacy 'italics' asciidoc [1], which caused the synopsis sections to render like this: 'ssh' -p 'gerrit some-command' Furthermore, the line breaks and indentations were not rendered. Replaced the legacy 'italics" with _italics_ in all synopsis sections and changed the block type to [verse]. Verse blocks preserve indents and line breaks (like
 in HTML), but still allow text formatting.

Fixed also some other minor mistakes and formatting errors.

[1] http://asciidoctor.org/docs/migration/#migration-cheatsheet

Change-Id: I457c5e42e3758789f29541d38d6f6c2e25532897
Signed-off-by: Michael Ochmann 
---
 Documentation/cmd-apropos.txt            |  8 +++++---
 Documentation/cmd-ban-commit.txt         |  3 ++-
 Documentation/cmd-cherry-pick.txt        |  7 ++++---
 Documentation/cmd-close-connection.txt   |  3 ++-
 Documentation/cmd-create-account.txt     |  3 ++-
 Documentation/cmd-create-branch.txt      |  3 ++-
 Documentation/cmd-create-group.txt       |  3 ++-
 Documentation/cmd-create-project.txt     |  3 ++-
 Documentation/cmd-flush-caches.txt       |  7 ++++---
 Documentation/cmd-gc.txt                 |  3 ++-
 Documentation/cmd-gsql.txt               |  3 ++-
 Documentation/cmd-index-activate.txt     |  3 ++-
 Documentation/cmd-index-changes.txt      |  3 ++-
 Documentation/cmd-index-start.txt        |  3 ++-
 Documentation/cmd-kill.txt               |  3 ++-
 Documentation/cmd-logging-ls-level.txt   |  3 ++-
 Documentation/cmd-logging-set-level.txt  |  3 ++-
 Documentation/cmd-ls-groups.txt          |  3 ++-
 Documentation/cmd-ls-members.txt         |  3 ++-
 Documentation/cmd-ls-projects.txt        |  3 ++-
 Documentation/cmd-ls-user-refs.txt       |  3 ++-
 Documentation/cmd-plugin-enable.txt      |  3 ++-
 Documentation/cmd-plugin-install.txt     |  3 ++-
 Documentation/cmd-plugin-ls.txt          |  3 ++-
 Documentation/cmd-plugin-reload.txt      |  3 ++-
 Documentation/cmd-plugin-remove.txt      |  3 ++-
 Documentation/cmd-query.txt              |  3 ++-
 Documentation/cmd-receive-pack.txt       |  3 ++-
 Documentation/cmd-rename-group.txt       |  3 ++-
 Documentation/cmd-review.txt             |  6 +++---
 Documentation/cmd-set-account.txt        | 16 +++++++++-------
 Documentation/cmd-set-head.txt           |  3 ++-
 Documentation/cmd-set-members.txt        |  3 ++-
 Documentation/cmd-set-project-parent.txt |  3 ++-
 Documentation/cmd-set-project.txt        |  3 ++-
 Documentation/cmd-set-reviewers.txt      |  3 ++-
 Documentation/cmd-show-caches.txt        |  5 ++++-
 Documentation/cmd-show-connections.txt   |  4 +++-
 Documentation/cmd-show-queue.txt         |  5 +++--
 Documentation/cmd-stream-events.txt      |  3 ++-
 Documentation/cmd-suexec.txt             |  7 ++++---
 Documentation/cmd-test-submit-rule.txt   |  3 ++-
 Documentation/cmd-test-submit-type.txt   |  3 ++-
 Documentation/cmd-version.txt            |  3 ++-
 44 files changed, 109 insertions(+), 61 deletions(-)

diff --git a/Documentation/cmd-apropos.txt b/Documentation/cmd-apropos.txt
index 8882af18c9..d03e63f3bf 100644
--- a/Documentation/cmd-apropos.txt
+++ b/Documentation/cmd-apropos.txt
@@ -4,8 +4,9 @@
 gerrit apropos - Search Gerrit documentation index
 
 == SYNOPSIS
+[verse]
 --
-'ssh' -p   'gerrit apropos'
+_ssh_ -p   _gerrit apropos_
   
 --
 
@@ -23,8 +24,9 @@ Note: this feature is only available if documentation index was built.
 
 == EXAMPLES
 
-=====
+----
 $ ssh -p 29418 review.example.com gerrit apropos capabilities
+
     Gerrit Code Review - /config/ REST API:
     http://localhost:8080/Documentation/rest-api-config.html
 
@@ -45,7 +47,7 @@ $ ssh -p 29418 review.example.com gerrit apropos capabilities
 
     Gerrit Code Review - /access/ REST API:
     http://localhost:8080/Documentation/rest-api-access.html
-=====
+----
 
 == SEE ALSO
 
diff --git a/Documentation/cmd-ban-commit.txt b/Documentation/cmd-ban-commit.txt
index d5c09afd9e..f4692cf1da 100644
--- a/Documentation/cmd-ban-commit.txt
+++ b/Documentation/cmd-ban-commit.txt
@@ -4,8 +4,9 @@
 gerrit ban-commit - Bans a commit from a project's repository.
 
 == SYNOPSIS
+[verse]
 --
-'ssh' -p   'gerrit ban-commit'
+_ssh_ -p   _gerrit ban-commit_
   [--reason ]
   
    ...
diff --git a/Documentation/cmd-cherry-pick.txt b/Documentation/cmd-cherry-pick.txt
index 0c4cf91611..f702c83e29 100644
--- a/Documentation/cmd-cherry-pick.txt
+++ b/Documentation/cmd-cherry-pick.txt
@@ -4,10 +4,11 @@
 gerrit-cherry-pick - Download and cherry pick one or more changes
 
 == SYNOPSIS
+[verse]
 --
-'gerrit-cherry-pick'  ...
-'gerrit-cherry-pick' --continue | --skip | --abort
-'gerrit-cherry-pick' --close 
+_gerrit-cherry-pick_  ...
+_gerrit-cherry-pick_ --continue | --skip | --abort
+_gerrit-cherry-pick_ --close 
 --
 
 == DESCRIPTION
diff --git a/Documentation/cmd-close-connection.txt b/Documentation/cmd-close-connection.txt
index 331432689d..973441e294 100644
--- a/Documentation/cmd-close-connection.txt
+++ b/Documentation/cmd-close-connection.txt
@@ -4,8 +4,9 @@
 gerrit close-connection - Close the specified SSH connection
 
 == SYNOPSIS
+[verse]
 --
-'ssh' -p   'gerrit close-connection' 
+_ssh_ -p   _gerrit close-connection_ 
    [--wait]
 --
 
diff --git a/Documentation/cmd-create-account.txt b/Documentation/cmd-create-account.txt
index 2159e0e006..e79ae5008f 100644
--- a/Documentation/cmd-create-account.txt
+++ b/Documentation/cmd-create-account.txt
@@ -4,8 +4,9 @@
 gerrit create-account - Create a new user account.
 
 == SYNOPSIS
+[verse]
 --
-'ssh' -p   'gerrit create-account'
+_ssh_ -p   _gerrit create-account_
   [--group ]
   [--full-name ]
   [--email ]
diff --git a/Documentation/cmd-create-branch.txt b/Documentation/cmd-create-branch.txt
index 671adfeef5..43d2b4f3c4 100644
--- a/Documentation/cmd-create-branch.txt
+++ b/Documentation/cmd-create-branch.txt
@@ -4,8 +4,9 @@
 gerrit create-branch - Create a new branch
 
 == SYNOPSIS
+[verse]
 --
-'ssh' -p   'gerrit create-branch'
+_ssh_ -p   _gerrit create-branch_
   
   
   
diff --git a/Documentation/cmd-create-group.txt b/Documentation/cmd-create-group.txt
index d02e2ead9f..e8d7bd5ae4 100644
--- a/Documentation/cmd-create-group.txt
+++ b/Documentation/cmd-create-group.txt
@@ -4,8 +4,9 @@
 gerrit create-group - Create a new account group.
 
 == SYNOPSIS
+[verse]
 --
-'ssh' -p   'gerrit create-group'
+_ssh_ -p   _gerrit create-group_
   [--owner  | -o ]
   [--description  | -d ]
   [--member ]
diff --git a/Documentation/cmd-create-project.txt b/Documentation/cmd-create-project.txt
index d1108b593b..72c7d57047 100644
--- a/Documentation/cmd-create-project.txt
+++ b/Documentation/cmd-create-project.txt
@@ -4,8 +4,9 @@
 gerrit create-project - Create a new hosted project
 
 == SYNOPSIS
+[verse]
 --
-'ssh' -p   'gerrit create-project'
+_ssh_ -p   _gerrit create-project_
   [--owner  ... | -o  ...]
   [--parent  | -p  ]
   [--suggest-parents | -S ]
diff --git a/Documentation/cmd-flush-caches.txt b/Documentation/cmd-flush-caches.txt
index aa9790d55e..55a201a5c3 100644
--- a/Documentation/cmd-flush-caches.txt
+++ b/Documentation/cmd-flush-caches.txt
@@ -4,10 +4,11 @@
 gerrit flush-caches - Flush some/all server caches from memory
 
 == SYNOPSIS
+[verse]
 --
-'ssh' -p   'gerrit flush-caches' --all
-'ssh' -p   'gerrit flush-caches' --list
-'ssh' -p   'gerrit flush-caches' --cache  ...
+_ssh_ -p   _gerrit flush-caches_ --all
+_ssh_ -p   _gerrit flush-caches_ --list
+_ssh_ -p   _gerrit flush-caches_ --cache  ...
 --
 
 == DESCRIPTION
diff --git a/Documentation/cmd-gc.txt b/Documentation/cmd-gc.txt
index b7388a1555..af098b1fd7 100644
--- a/Documentation/cmd-gc.txt
+++ b/Documentation/cmd-gc.txt
@@ -4,8 +4,9 @@
 gerrit gc - Run the Git garbage collection
 
 == SYNOPSIS
+[verse]
 --
-'ssh' -p   'gerrit gc'
+_ssh_ -p   _gerrit gc_
   [--all]
   [--show-progress]
   [--aggressive]
diff --git a/Documentation/cmd-gsql.txt b/Documentation/cmd-gsql.txt
index 411eb000d1..d55ba2ba75 100644
--- a/Documentation/cmd-gsql.txt
+++ b/Documentation/cmd-gsql.txt
@@ -4,8 +4,9 @@
 gerrit gsql - Administrative interface to active database
 
 == SYNOPSIS
+[verse]
 --
-'ssh' -p   'gerrit gsql'
+_ssh_ -p   _gerrit gsql_
   [--format {PRETTY | JSON | JSON_SINGLE}]
   [-c QUERY]
 --
diff --git a/Documentation/cmd-index-activate.txt b/Documentation/cmd-index-activate.txt
index 6cb7781f1a..56ffa4cc65 100644
--- a/Documentation/cmd-index-activate.txt
+++ b/Documentation/cmd-index-activate.txt
@@ -4,8 +4,9 @@
 gerrit index activate - Activate the latest index version available
 
 == SYNOPSIS
+[verse]
 --
-'ssh' -p   'gerrit index activate '
+_ssh_ -p   _gerrit index activate _
 --
 
 == DESCRIPTION
diff --git a/Documentation/cmd-index-changes.txt b/Documentation/cmd-index-changes.txt
index 8566827a47..8560c7c85b 100644
--- a/Documentation/cmd-index-changes.txt
+++ b/Documentation/cmd-index-changes.txt
@@ -4,8 +4,9 @@
 gerrit index changes - Index one or more changes.
 
 == SYNOPSIS
+[verse]
 --
-'ssh' -p   'gerrit index changes'  [ ...]
+_ssh_ -p   _gerrit index changes_  [ ...]
 --
 
 == DESCRIPTION
diff --git a/Documentation/cmd-index-start.txt b/Documentation/cmd-index-start.txt
index 0a481e5835..5482127f41 100644
--- a/Documentation/cmd-index-start.txt
+++ b/Documentation/cmd-index-start.txt
@@ -4,8 +4,9 @@
 gerrit index start - Start the online indexer
 
 == SYNOPSIS
+[verse]
 --
-'ssh' -p   'gerrit index start '
+_ssh_ -p   _gerrit index start_ 
 --
 
 == DESCRIPTION
diff --git a/Documentation/cmd-kill.txt b/Documentation/cmd-kill.txt
index c64c537165..ac8e8028a3 100644
--- a/Documentation/cmd-kill.txt
+++ b/Documentation/cmd-kill.txt
@@ -4,8 +4,9 @@
 kill - Cancel or abort a background task
 
 == SYNOPSIS
+[verse]
 --
-'ssh' -p   'kill'  ...
+_ssh_ -p   _kill_  ...
 --
 
 == DESCRIPTION
diff --git a/Documentation/cmd-logging-ls-level.txt b/Documentation/cmd-logging-ls-level.txt
index c59dc3f435..b81bc8f2a1 100644
--- a/Documentation/cmd-logging-ls-level.txt
+++ b/Documentation/cmd-logging-ls-level.txt
@@ -6,8 +6,9 @@ gerrit logging ls-level - view the logging level
 gerrit logging ls - view the logging level
 
 == SYNOPSIS
+[verse]
 --
-'ssh' -p   'gerrit logging ls-level | ls'
+_ssh_ -p   _gerrit logging ls-level_ | _ls_
   
 --
 
diff --git a/Documentation/cmd-logging-set-level.txt b/Documentation/cmd-logging-set-level.txt
index 38062cb340..fcf93111bf 100644
--- a/Documentation/cmd-logging-set-level.txt
+++ b/Documentation/cmd-logging-set-level.txt
@@ -6,8 +6,9 @@ gerrit logging set-level - set the logging level
 gerrit logging set - set the logging level
 
 == SYNOPSIS
+[verse]
 --
-'ssh' -p   'gerrit logging set-level | set'
+_ssh_ -p   _gerrit logging set-level_ | _set_
   
   
 --
diff --git a/Documentation/cmd-ls-groups.txt b/Documentation/cmd-ls-groups.txt
index 651cebe325..8853854eb3 100644
--- a/Documentation/cmd-ls-groups.txt
+++ b/Documentation/cmd-ls-groups.txt
@@ -4,8 +4,9 @@
 gerrit ls-groups - List groups visible to caller
 
 == SYNOPSIS
+[verse]
 --
-'ssh' -p   'gerrit ls-groups'
+_ssh_ -p   _gerrit ls-groups_
   [--project  | -p ]
   [--user  | -u ]
   [--owned]
diff --git a/Documentation/cmd-ls-members.txt b/Documentation/cmd-ls-members.txt
index f8708d3f53..52428f9faa 100644
--- a/Documentation/cmd-ls-members.txt
+++ b/Documentation/cmd-ls-members.txt
@@ -4,8 +4,9 @@
 gerrit ls-members - Show members of a given group
 
 == SYNOPSIS
+[verse]
 --
-'ssh' -p   'gerrit ls-members GROUPNAME'
+_ssh_ -p   _gerrit ls-members_ GROUPNAME
   [--recursive]
 --
 
diff --git a/Documentation/cmd-ls-projects.txt b/Documentation/cmd-ls-projects.txt
index 2a8891538d..3dc8ff7c30 100644
--- a/Documentation/cmd-ls-projects.txt
+++ b/Documentation/cmd-ls-projects.txt
@@ -4,8 +4,9 @@
 gerrit ls-projects - List projects visible to caller
 
 == SYNOPSIS
+[verse]
 --
-'ssh' -p   'gerrit ls-projects'
+_ssh_ -p   _gerrit ls-projects_
   [--show-branch  ...]
   [--description | -d]
   [--tree | -t]
diff --git a/Documentation/cmd-ls-user-refs.txt b/Documentation/cmd-ls-user-refs.txt
index 11781debe4..03e54cf982 100644
--- a/Documentation/cmd-ls-user-refs.txt
+++ b/Documentation/cmd-ls-user-refs.txt
@@ -4,8 +4,9 @@
 gerrit ls-user-refs - List refs visible to a specific user
 
 == SYNOPSIS
+[verse]
 --
-'ssh' -p   'gerrit ls-user-refs'
+_ssh_ -p   _gerrit ls-user-refs_
   [--project PROJECT> | -p ]
   [--user  | -u ]
   [--only-refs-heads]
diff --git a/Documentation/cmd-plugin-enable.txt b/Documentation/cmd-plugin-enable.txt
index c8022ef6ae..508f972336 100644
--- a/Documentation/cmd-plugin-enable.txt
+++ b/Documentation/cmd-plugin-enable.txt
@@ -4,8 +4,9 @@
 plugin enable - Enable plugins.
 
 == SYNOPSIS
+[verse]
 --
-'ssh' -p   'gerrit plugin enable'
+_ssh_ -p   _gerrit plugin enable_
    ...
 --
 
diff --git a/Documentation/cmd-plugin-install.txt b/Documentation/cmd-plugin-install.txt
index 0ce6d7de57..e701f984fc 100644
--- a/Documentation/cmd-plugin-install.txt
+++ b/Documentation/cmd-plugin-install.txt
@@ -6,8 +6,9 @@ plugin install - Install/Add a plugin.
 plugin add - Install/Add a plugin.
 
 == SYNOPSIS
+[verse]
 --
-'ssh' -p   'gerrit plugin install | add'
+_ssh_ -p   _gerrit plugin install_ | _add_
   [--name  | -n ]
   - |  | 
 --
diff --git a/Documentation/cmd-plugin-ls.txt b/Documentation/cmd-plugin-ls.txt
index 234ce8758b..d329db5ced 100644
--- a/Documentation/cmd-plugin-ls.txt
+++ b/Documentation/cmd-plugin-ls.txt
@@ -4,8 +4,9 @@
 plugin ls - List the installed plugins.
 
 == SYNOPSIS
+[verse]
 --
-'ssh' -p   'gerrit plugin ls'
+_ssh_ -p   _gerrit plugin ls_
   [--all | -a]
   [--format {text | json | json_compact}]
 --
diff --git a/Documentation/cmd-plugin-reload.txt b/Documentation/cmd-plugin-reload.txt
index 88cb1f33e6..ad93f517af 100644
--- a/Documentation/cmd-plugin-reload.txt
+++ b/Documentation/cmd-plugin-reload.txt
@@ -4,8 +4,9 @@
 plugin reload - Reload/Restart plugins.
 
 == SYNOPSIS
+[verse]
 --
-'ssh' -p   'gerrit plugin reload'
+_ssh_ -p   _gerrit plugin reload_
    ...
 --
 
diff --git a/Documentation/cmd-plugin-remove.txt b/Documentation/cmd-plugin-remove.txt
index 770df853da..9e449a2bd0 100644
--- a/Documentation/cmd-plugin-remove.txt
+++ b/Documentation/cmd-plugin-remove.txt
@@ -6,8 +6,9 @@ plugin remove - Disable plugins.
 plugin rm - Disable plugins.
 
 == SYNOPSIS
+[verse]
 --
-'ssh' -p   'gerrit plugin remove | rm'
+_ssh_ -p   _gerrit plugin remove_ | _rm_
    ...
 --
 
diff --git a/Documentation/cmd-query.txt b/Documentation/cmd-query.txt
index 090781b1bc..2a47364f6c 100644
--- a/Documentation/cmd-query.txt
+++ b/Documentation/cmd-query.txt
@@ -4,8 +4,9 @@
 gerrit query - Query the change database
 
 == SYNOPSIS
+[verse]
 --
-'ssh' -p   'gerrit query'
+_ssh_ -p   _gerrit query_
   [--format {TEXT | JSON}]
   [--current-patch-set]
   [--patch-sets | --all-approvals]
diff --git a/Documentation/cmd-receive-pack.txt b/Documentation/cmd-receive-pack.txt
index f3b4f0263b..0285ef7e17 100644
--- a/Documentation/cmd-receive-pack.txt
+++ b/Documentation/cmd-receive-pack.txt
@@ -4,8 +4,9 @@
 git-receive-pack - Receive what is pushed into the repository
 
 == SYNOPSIS
+[verse]
 --
-'git receive-pack'
+_git receive-pack_
   [--reviewer 
| --re
] [--cc
] diff --git a/Documentation/cmd-rename-group.txt b/Documentation/cmd-rename-group.txt index 9578458cba..dd18c6fb63 100644 --- a/Documentation/cmd-rename-group.txt +++ b/Documentation/cmd-rename-group.txt @@ -4,8 +4,9 @@ gerrit rename-group - Rename an account group. == SYNOPSIS +[verse] -- -'ssh' -p 'gerrit rename-group' +_ssh_ -p _gerrit rename-group_ -- diff --git a/Documentation/cmd-review.txt b/Documentation/cmd-review.txt index c3d86512e0..a4aedf134c 100644 --- a/Documentation/cmd-review.txt +++ b/Documentation/cmd-review.txt @@ -1,12 +1,12 @@ -gerrit review -============== += gerrit review == NAME gerrit review - Apply reviews to one or more patch sets == SYNOPSIS +[verse] -- -'ssh' -p 'gerrit review' +_ssh_ -p _gerrit review_ [--project | -p ] [--branch | -b ] [--message | -m ] diff --git a/Documentation/cmd-set-account.txt b/Documentation/cmd-set-account.txt index 8fb8e0d6ab..17e2f66ad1 100644 --- a/Documentation/cmd-set-account.txt +++ b/Documentation/cmd-set-account.txt @@ -4,14 +4,16 @@ gerrit set-account - Change an account's settings. == SYNOPSIS +[verse] -- -set-account [--full-name ] [--active|--inactive] \ - [--add-email ] [--delete-email | ALL] \ - [--preferred-email ] \ - [--add-ssh-key - | ] \ - [--delete-ssh-key - | | ALL] \ - [--http-password ] \ - [--clear-http-password] +_ssh_ -p _gerrit set-account_ + [--full-name ] [--active|--inactive] + [--add-email ] [--delete-email | ALL] + [--preferred-email ] + [--add-ssh-key - | ] + [--delete-ssh-key - | | ALL] + [--http-password ] + [--clear-http-password] -- == DESCRIPTION diff --git a/Documentation/cmd-set-head.txt b/Documentation/cmd-set-head.txt index d74caaa201..270a48aed2 100644 --- a/Documentation/cmd-set-head.txt +++ b/Documentation/cmd-set-head.txt @@ -4,8 +4,9 @@ gerrit set-head - Change a project's HEAD. == SYNOPSIS +[verse] -- -'ssh' -p 'gerrit set-head' +_ssh_ -p _gerrit set-head_ --new-head -- diff --git a/Documentation/cmd-set-members.txt b/Documentation/cmd-set-members.txt index 174a25a39d..63eed27385 100644 --- a/Documentation/cmd-set-members.txt +++ b/Documentation/cmd-set-members.txt @@ -4,8 +4,9 @@ gerrit set-members - Set group members == SYNOPSIS +[verse] -- -'ssh' -p 'gerrit set-members' +_ssh_ -p _gerrit set-members_ [--add USER ...] [--remove USER ...] [--include GROUP ...] diff --git a/Documentation/cmd-set-project-parent.txt b/Documentation/cmd-set-project-parent.txt index 70918b2856..523b13d6d4 100644 --- a/Documentation/cmd-set-project-parent.txt +++ b/Documentation/cmd-set-project-parent.txt @@ -4,8 +4,9 @@ gerrit set-project-parent - Change the project permissions are inherited from. == SYNOPSIS +[verse] -- -'ssh' -p 'gerrit set-project-parent' +_ssh_ -p _gerrit set-project-parent_ [--parent ] [--children-of ] [--exclude ] diff --git a/Documentation/cmd-set-project.txt b/Documentation/cmd-set-project.txt index 2b64d7783e..a0f8cf2cf3 100644 --- a/Documentation/cmd-set-project.txt +++ b/Documentation/cmd-set-project.txt @@ -4,8 +4,9 @@ gerrit set-project - Change a project's settings. == SYNOPSIS +[verse] -- -'ssh' -p 'gerrit set-project' +_ssh_ -p _gerrit set-project_ [--description | -d ] [--submit-type | -t ] [--contributor-agreements ] diff --git a/Documentation/cmd-set-reviewers.txt b/Documentation/cmd-set-reviewers.txt index d5b4908380..58e3570885 100644 --- a/Documentation/cmd-set-reviewers.txt +++ b/Documentation/cmd-set-reviewers.txt @@ -4,8 +4,9 @@ gerrit set-reviewers - Add or remove reviewers to a change == SYNOPSIS +[verse] -- -'ssh' -p 'gerrit set-reviewers' +_ssh_ -p _gerrit set-reviewers_ [--project | -p ] [--add ... | -a ...] [--remove ... | -r ...] diff --git a/Documentation/cmd-show-caches.txt b/Documentation/cmd-show-caches.txt index 5d6ab20c1e..9ef0194128 100644 --- a/Documentation/cmd-show-caches.txt +++ b/Documentation/cmd-show-caches.txt @@ -5,8 +5,11 @@ gerrit show-caches gerrit show-caches - Display current cache statistics == SYNOPSIS +[verse] -- -'ssh' -p 'gerrit show-caches' [--gc] [--show-jvm] +_ssh_ -p _gerrit show-caches_ + [--gc] + [--show-jvm] -- == DESCRIPTION diff --git a/Documentation/cmd-show-connections.txt b/Documentation/cmd-show-connections.txt index a694fb3f19..d320eeec8e 100644 --- a/Documentation/cmd-show-connections.txt +++ b/Documentation/cmd-show-connections.txt @@ -4,8 +4,10 @@ gerrit show-connections - Display active client SSH connections == SYNOPSIS +[verse] -- -'ssh' -p 'gerrit show-connections' [--numeric | -n] +_ssh_ -p _gerrit show-connections_ + [--numeric | -n] -- == DESCRIPTION diff --git a/Documentation/cmd-show-queue.txt b/Documentation/cmd-show-queue.txt index e3f44abe18..5578e2b6c3 100644 --- a/Documentation/cmd-show-queue.txt +++ b/Documentation/cmd-show-queue.txt @@ -4,9 +4,10 @@ gerrit show-queue - Display the background work queues, including replication == SYNOPSIS +[verse] -- -'ssh' -p 'gerrit show-queue' -'ssh' -p 'ps' +_ssh_ -p _gerrit show-queue_ +_ssh_ -p _ps_ -- == DESCRIPTION diff --git a/Documentation/cmd-stream-events.txt b/Documentation/cmd-stream-events.txt index 028bd5832d..83838d890a 100644 --- a/Documentation/cmd-stream-events.txt +++ b/Documentation/cmd-stream-events.txt @@ -4,8 +4,9 @@ gerrit stream-events - Monitor events occurring in real time == SYNOPSIS +[verse] -- -'ssh' -p 'gerrit stream-events' +_ssh_ -p _gerrit stream-events_ -- == DESCRIPTION diff --git a/Documentation/cmd-suexec.txt b/Documentation/cmd-suexec.txt index f6ee753cc6..0cfd8e0444 100644 --- a/Documentation/cmd-suexec.txt +++ b/Documentation/cmd-suexec.txt @@ -4,11 +4,12 @@ suexec - Execute a command as any registered user account == SYNOPSIS +[verse] -- -'ssh' -p +_ssh_ -p -i SITE_PATH/etc/ssh_host_rsa_key - '"Gerrit Code Review@localhost"' - 'suexec' + "Gerrit Code Review@localhost" + _suexec_ --as [--from HOST:PORT] [--] diff --git a/Documentation/cmd-test-submit-rule.txt b/Documentation/cmd-test-submit-rule.txt index a9a1bc4b0d..9244833aa8 100644 --- a/Documentation/cmd-test-submit-rule.txt +++ b/Documentation/cmd-test-submit-rule.txt @@ -4,8 +4,9 @@ gerrit test-submit rule - Test prolog submit rules with a chosen changeset. == SYNOPSIS +[verse] -- -'ssh' -p 'gerrit test-submit rule' +_ssh_ -p _gerrit test-submit_ rule [-s] [--no-filters] CHANGE diff --git a/Documentation/cmd-test-submit-type.txt b/Documentation/cmd-test-submit-type.txt index 658d43bdcc..250f97490c 100644 --- a/Documentation/cmd-test-submit-type.txt +++ b/Documentation/cmd-test-submit-type.txt @@ -4,8 +4,9 @@ gerrit test-submit type - Test prolog submit type with a chosen change. == SYNOPSIS +[verse] -- -'ssh' -p 'gerrit test-submit type' +_ssh_ -p _gerrit test-submit_ type [-s] [--no-filters] CHANGE diff --git a/Documentation/cmd-version.txt b/Documentation/cmd-version.txt index d5c2263bff..dd3b096d15 100644 --- a/Documentation/cmd-version.txt +++ b/Documentation/cmd-version.txt @@ -4,8 +4,9 @@ gerrit version - Show the version of the currently executing Gerrit server == SYNOPSIS +[verse] -- -'ssh' -p 'gerrit version' +_ssh_ -p _gerrit version_ -- == DESCRIPTION