Bypass the rendering differences in AsciiDoctor.
AsciiDoctor have different understanding of [verse] with asciidoc, causing some
rendering differences. To get similar result with asciidoc, we use something
else instead of [verse] now.
Screenshots:
before:
http://imgur.com/JKMdBiv
after:
http://imgur.com/yFVvVac
Change-Id: I14e84f0e998e1e87b633681e8028ad657bde07e4
diff --git a/Documentation/access-control.txt b/Documentation/access-control.txt
index f8d4308..b4181e9 100644
--- a/Documentation/access-control.txt
+++ b/Documentation/access-control.txt
@@ -335,10 +335,11 @@
hundreds of thousands of patch sets. To access a given patch set you will
need the change number and patch set number.
-[verse]
+--
'refs/changes/'<last two digits of change number>/
<change number>/
<patch set number>
+--
You can also find these static references linked on the page of each change.
diff --git a/Documentation/cmd-apropos.txt b/Documentation/cmd-apropos.txt
index 29ce9fa..e980a05 100644
--- a/Documentation/cmd-apropos.txt
+++ b/Documentation/cmd-apropos.txt
@@ -7,9 +7,10 @@
SYNOPSIS
--------
-[verse]
+--
'ssh' -p <port> <host> 'gerrit apropos'
<query>
+--
DESCRIPTION
-----------
diff --git a/Documentation/cmd-ban-commit.txt b/Documentation/cmd-ban-commit.txt
index fcdad5c..b7ec0cf 100644
--- a/Documentation/cmd-ban-commit.txt
+++ b/Documentation/cmd-ban-commit.txt
@@ -7,11 +7,12 @@
SYNOPSIS
--------
-[verse]
+--
'ssh' -p <port> <host> 'gerrit ban-commit'
[--reason <REASON>]
<PROJECT>
<COMMIT> ...
+--
DESCRIPTION
-----------
diff --git a/Documentation/cmd-cherry-pick.txt b/Documentation/cmd-cherry-pick.txt
index 1275d20ea..07cbadf 100644
--- a/Documentation/cmd-cherry-pick.txt
+++ b/Documentation/cmd-cherry-pick.txt
@@ -7,10 +7,11 @@
SYNOPSIS
--------
-[verse]
+--
'gerrit-cherry-pick' <remote> <changeid>...
'gerrit-cherry-pick' --continue | --skip | --abort
'gerrit-cherry-pick' --close <remote>
+--
DESCRIPTION
-----------
diff --git a/Documentation/cmd-create-account.txt b/Documentation/cmd-create-account.txt
index f22b4df..9d27865 100644
--- a/Documentation/cmd-create-account.txt
+++ b/Documentation/cmd-create-account.txt
@@ -7,7 +7,7 @@
SYNOPSIS
--------
-[verse]
+--
'ssh' -p <port> <host> 'gerrit create-account'
[--group <GROUP>]
[--full-name <FULLNAME>]
@@ -15,6 +15,7 @@
[--ssh-key - | <KEY>]
[--http-password <PASSWORD>]
<USERNAME>
+--
DESCRIPTION
-----------
diff --git a/Documentation/cmd-create-group.txt b/Documentation/cmd-create-group.txt
index 1102a6d..bd419fc 100644
--- a/Documentation/cmd-create-group.txt
+++ b/Documentation/cmd-create-group.txt
@@ -7,7 +7,7 @@
SYNOPSIS
--------
-[verse]
+--
'ssh' -p <port> <host> 'gerrit create-group'
[--owner <GROUP> | -o <GROUP>]
[--description <DESC> | -d <DESC>]
@@ -15,6 +15,7 @@
[--group <GROUP>]
[--visible-to-all]
<GROUP>
+--
DESCRIPTION
-----------
diff --git a/Documentation/cmd-create-project.txt b/Documentation/cmd-create-project.txt
index da7820f..56aaa43 100644
--- a/Documentation/cmd-create-project.txt
+++ b/Documentation/cmd-create-project.txt
@@ -7,7 +7,7 @@
SYNOPSIS
--------
-[verse]
+--
'ssh' -p <port> <host> 'gerrit create-project'
[--owner <GROUP> ... | -o <GROUP> ...]
[--parent <NAME> | -p <NAME> ]
@@ -23,6 +23,7 @@
[--empty-commit]
[--max-object-size-limit <N>]
{ <NAME> | --name <NAME> }
+--
DESCRIPTION
-----------
diff --git a/Documentation/cmd-flush-caches.txt b/Documentation/cmd-flush-caches.txt
index 050b433..96a3062 100644
--- a/Documentation/cmd-flush-caches.txt
+++ b/Documentation/cmd-flush-caches.txt
@@ -7,10 +7,11 @@
SYNOPSIS
--------
-[verse]
+--
'ssh' -p <port> <host> 'gerrit flush-caches' --all
'ssh' -p <port> <host> 'gerrit flush-caches' --list
'ssh' -p <port> <host> 'gerrit flush-caches' --cache <NAME> ...
+--
DESCRIPTION
-----------
diff --git a/Documentation/cmd-gc.txt b/Documentation/cmd-gc.txt
index 3066ca0..43dc03d 100644
--- a/Documentation/cmd-gc.txt
+++ b/Documentation/cmd-gc.txt
@@ -7,11 +7,12 @@
SYNOPSIS
--------
-[verse]
+--
'ssh' -p <port> <host> 'gerrit gc'
[--all]
[--show-progress]
<NAME> ...
+--
DESCRIPTION
-----------
diff --git a/Documentation/cmd-gsql.txt b/Documentation/cmd-gsql.txt
index 4efbb2a..951f372 100644
--- a/Documentation/cmd-gsql.txt
+++ b/Documentation/cmd-gsql.txt
@@ -7,10 +7,11 @@
SYNOPSIS
--------
-[verse]
+--
'ssh' -p <port> <host> 'gerrit gsql'
[--format {PRETTY | JSON | JSON_SINGLE}]
[-c QUERY]
+--
DESCRIPTION
-----------
diff --git a/Documentation/cmd-kill.txt b/Documentation/cmd-kill.txt
index 94371f0..649f148 100644
--- a/Documentation/cmd-kill.txt
+++ b/Documentation/cmd-kill.txt
@@ -7,8 +7,9 @@
SYNOPSIS
--------
-[verse]
+--
'ssh' -p <port> <host> 'kill' <ID> ...
+--
DESCRIPTION
-----------
diff --git a/Documentation/cmd-ls-groups.txt b/Documentation/cmd-ls-groups.txt
index 0713947..c79dbdc 100644
--- a/Documentation/cmd-ls-groups.txt
+++ b/Documentation/cmd-ls-groups.txt
@@ -7,7 +7,7 @@
SYNOPSIS
--------
-[verse]
+--
'ssh' -p <port> <host> 'gerrit ls-groups'
[--project <NAME> | -p <NAME>]
[--user <NAME> | -u <NAME>]
@@ -16,6 +16,7 @@
[--type {internal | system}]
[-q <GROUP>]
[--verbose | -v]
+--
DESCRIPTION
-----------
diff --git a/Documentation/cmd-ls-members.txt b/Documentation/cmd-ls-members.txt
index d5f127f..23315503 100644
--- a/Documentation/cmd-ls-members.txt
+++ b/Documentation/cmd-ls-members.txt
@@ -7,9 +7,10 @@
SYNOPSIS
--------
-[verse]
+--
'ssh' -p <port> <host> 'gerrit ls-members GROUPNAME'
[--recursive]
+--
DESCRIPTION
-----------
diff --git a/Documentation/cmd-ls-projects.txt b/Documentation/cmd-ls-projects.txt
index 5cd416d1..948baa7 100644
--- a/Documentation/cmd-ls-projects.txt
+++ b/Documentation/cmd-ls-projects.txt
@@ -7,7 +7,7 @@
SYNOPSIS
--------
-[verse]
+--
'ssh' -p <port> <host> 'gerrit ls-projects'
[--show-branch <BRANCH> ...]
[--description | -d]
@@ -17,6 +17,7 @@
[--all]
[--limit <N>]
[--has-acl-for GROUP]
+--
DESCRIPTION
-----------
diff --git a/Documentation/cmd-ls-user-refs.txt b/Documentation/cmd-ls-user-refs.txt
index 26a083c..bd59f75 100644
--- a/Documentation/cmd-ls-user-refs.txt
+++ b/Documentation/cmd-ls-user-refs.txt
@@ -7,11 +7,12 @@
SYNOPSIS
--------
-[verse]
+--
'ssh' -p <port> <host> 'gerrit ls-user-refs'
[--project PROJECT> | -p <PROJECT>]
[--user <USER> | -u <USER>]
[--only-refs-heads]
+--
DESCRIPTION
-----------
diff --git a/Documentation/cmd-plugin-enable.txt b/Documentation/cmd-plugin-enable.txt
index ad1736d..a8356af 100644
--- a/Documentation/cmd-plugin-enable.txt
+++ b/Documentation/cmd-plugin-enable.txt
@@ -7,9 +7,10 @@
SYNOPSIS
--------
-[verse]
+--
'ssh' -p <port> <host> 'gerrit plugin enable'
<NAME> ...
+--
DESCRIPTION
-----------
diff --git a/Documentation/cmd-plugin-install.txt b/Documentation/cmd-plugin-install.txt
index 61663a6..592fd74 100644
--- a/Documentation/cmd-plugin-install.txt
+++ b/Documentation/cmd-plugin-install.txt
@@ -9,10 +9,11 @@
SYNOPSIS
--------
-[verse]
+--
'ssh' -p <port> <host> 'gerrit plugin install | add'
[--name <NAME> | -n <NAME>]
- | <URL> | <PATH>
+--
DESCRIPTION
-----------
diff --git a/Documentation/cmd-plugin-ls.txt b/Documentation/cmd-plugin-ls.txt
index 5e651b7..fe7b6b2 100644
--- a/Documentation/cmd-plugin-ls.txt
+++ b/Documentation/cmd-plugin-ls.txt
@@ -7,10 +7,11 @@
SYNOPSIS
--------
-[verse]
+--
'ssh' -p <port> <host> 'gerrit plugin ls'
[--all | -a]
[--format {text | json | json_compact}]
+--
DESCRIPTION
-----------
diff --git a/Documentation/cmd-plugin-reload.txt b/Documentation/cmd-plugin-reload.txt
index a4490a8..ecf1ff4 100644
--- a/Documentation/cmd-plugin-reload.txt
+++ b/Documentation/cmd-plugin-reload.txt
@@ -7,9 +7,10 @@
SYNOPSIS
--------
-[verse]
+--
'ssh' -p <port> <host> 'gerrit plugin reload'
<NAME> ...
+--
DESCRIPTION
-----------
diff --git a/Documentation/cmd-plugin-remove.txt b/Documentation/cmd-plugin-remove.txt
index f9c0eea..d9520ae 100644
--- a/Documentation/cmd-plugin-remove.txt
+++ b/Documentation/cmd-plugin-remove.txt
@@ -9,9 +9,10 @@
SYNOPSIS
--------
-[verse]
+--
'ssh' -p <port> <host> 'gerrit plugin remove | rm'
<NAME> ...
+--
DESCRIPTION
-----------
diff --git a/Documentation/cmd-query.txt b/Documentation/cmd-query.txt
index 249b7f9..ad28258 100644
--- a/Documentation/cmd-query.txt
+++ b/Documentation/cmd-query.txt
@@ -7,7 +7,7 @@
SYNOPSIS
--------
-[verse]
+--
'ssh' -p <port> <host> 'gerrit query'
[--format {TEXT | JSON}]
[--current-patch-set]
@@ -22,6 +22,7 @@
<query>
[limit:<n>]
[resume_sortkey:<sortKey>]
+--
DESCRIPTION
-----------
diff --git a/Documentation/cmd-receive-pack.txt b/Documentation/cmd-receive-pack.txt
index 239d2f5..2742b9c 100644
--- a/Documentation/cmd-receive-pack.txt
+++ b/Documentation/cmd-receive-pack.txt
@@ -7,11 +7,12 @@
SYNOPSIS
--------
-[verse]
+--
'git receive-pack'
[--reviewer <address> | --re <address>]
[--cc <address>]
<project>
+--
DESCRIPTION
-----------
diff --git a/Documentation/cmd-rename-group.txt b/Documentation/cmd-rename-group.txt
index 624ac9b..639450f 100644
--- a/Documentation/cmd-rename-group.txt
+++ b/Documentation/cmd-rename-group.txt
@@ -7,10 +7,11 @@
SYNOPSIS
--------
-[verse]
+--
'ssh' -p <port> <host> 'gerrit rename-group'
<GROUP>
<NEWNAME>
+--
DESCRIPTION
-----------
diff --git a/Documentation/cmd-review.txt b/Documentation/cmd-review.txt
index 3038ead..97eb746 100644
--- a/Documentation/cmd-review.txt
+++ b/Documentation/cmd-review.txt
@@ -7,7 +7,7 @@
SYNOPSIS
--------
-[verse]
+--
'ssh' -p <port> <host> 'gerrit review'
[--project <PROJECT> | -p <PROJECT>]
[--message <MESSAGE> | -m <MESSAGE>]
@@ -18,6 +18,7 @@
[--verified <N>] [--code-review <N>]
[--label Label-Name=<N>]
{COMMIT | CHANGEID,PATCHSET}...
+--
DESCRIPTION
-----------
diff --git a/Documentation/cmd-set-account.txt b/Documentation/cmd-set-account.txt
index 19eb468..5dd6951 100644
--- a/Documentation/cmd-set-account.txt
+++ b/Documentation/cmd-set-account.txt
@@ -7,12 +7,13 @@
SYNOPSIS
--------
-[verse]
+--
set-account [--full-name <FULLNAME>] [--active|--inactive] \
[--add-email <EMAIL>] [--delete-email <EMAIL> | ALL] \
[--add-ssh-key - | <KEY>] \
[--delete-ssh-key - | <KEY> | ALL] \
[--http-password <PASSWORD>] <USER>
+--
DESCRIPTION
-----------
diff --git a/Documentation/cmd-set-members.txt b/Documentation/cmd-set-members.txt
index d7da2eb..e8866ba 100644
--- a/Documentation/cmd-set-members.txt
+++ b/Documentation/cmd-set-members.txt
@@ -7,7 +7,7 @@
SYNOPSIS
--------
-[verse]
+--
'ssh' -p <port> <host> 'gerrit set-members'
[--add USER ...]
[--remove USER ...]
@@ -15,6 +15,7 @@
[--exclude GROUP ...]
[--]
<GROUP> ...
+--
DESCRIPTION
-----------
diff --git a/Documentation/cmd-set-project-parent.txt b/Documentation/cmd-set-project-parent.txt
index 5664890..2fe9e0e 100644
--- a/Documentation/cmd-set-project-parent.txt
+++ b/Documentation/cmd-set-project-parent.txt
@@ -7,12 +7,13 @@
SYNOPSIS
--------
-[verse]
+--
'ssh' -p <port> <host> 'gerrit set-project-parent'
[--parent <NAME>]
[--children-of <NAME>]
[--exclude <NAME>]
<NAME> ...
+--
DESCRIPTION
-----------
diff --git a/Documentation/cmd-set-project.txt b/Documentation/cmd-set-project.txt
index df694a0..6fd0077 100644
--- a/Documentation/cmd-set-project.txt
+++ b/Documentation/cmd-set-project.txt
@@ -7,7 +7,7 @@
SYNOPSIS
--------
-[verse]
+--
'ssh' -p <port> <host> 'gerrit set-project'
[--description <DESC> | -d <DESC>]
[--submit-type <TYPE> | -t <TYPE>]
@@ -18,6 +18,7 @@
[--project-state <STATE> | --ps <STATE>]
[--max-object-size-limit <N>]
<NAME>
+--
DESCRIPTION
-----------
diff --git a/Documentation/cmd-set-reviewers.txt b/Documentation/cmd-set-reviewers.txt
index 81b493d..9310155 100644
--- a/Documentation/cmd-set-reviewers.txt
+++ b/Documentation/cmd-set-reviewers.txt
@@ -7,13 +7,14 @@
SYNOPSIS
--------
-[verse]
+--
'ssh' -p <port> <host> 'gerrit set-reviewers'
[--project <PROJECT> | -p <PROJECT>]
[--add <REVIEWER> ... | -a <REVIEWER> ...]
[--remove <REVIEWER> ... | -r <REVIEWER> ...]
[--]
{COMMIT | CHANGE-ID}...
+--
DESCRIPTION
-----------
diff --git a/Documentation/cmd-show-caches.txt b/Documentation/cmd-show-caches.txt
index 8c64b05..7b93dda 100644
--- a/Documentation/cmd-show-caches.txt
+++ b/Documentation/cmd-show-caches.txt
@@ -7,8 +7,9 @@
SYNOPSIS
--------
-[verse]
+--
'ssh' -p <port> <host> 'gerrit show-caches' [--gc] [--show-jvm]
+--
DESCRIPTION
-----------
diff --git a/Documentation/cmd-show-connections.txt b/Documentation/cmd-show-connections.txt
index 154e1c2..10d3375 100644
--- a/Documentation/cmd-show-connections.txt
+++ b/Documentation/cmd-show-connections.txt
@@ -7,8 +7,9 @@
SYNOPSIS
--------
-[verse]
+--
'ssh' -p <port> <host> 'gerrit show-connections' [--numeric | -n]
+--
DESCRIPTION
-----------
diff --git a/Documentation/cmd-show-queue.txt b/Documentation/cmd-show-queue.txt
index 7364d2d..bba82c3 100644
--- a/Documentation/cmd-show-queue.txt
+++ b/Documentation/cmd-show-queue.txt
@@ -7,9 +7,10 @@
SYNOPSIS
--------
-[verse]
+--
'ssh' -p <port> <host> 'gerrit show-queue'
'ssh' -p <port> <host> 'ps'
+--
DESCRIPTION
-----------
diff --git a/Documentation/cmd-stream-events.txt b/Documentation/cmd-stream-events.txt
index 746b3ea..15634e2 100644
--- a/Documentation/cmd-stream-events.txt
+++ b/Documentation/cmd-stream-events.txt
@@ -7,8 +7,9 @@
SYNOPSIS
--------
-[verse]
+--
'ssh' -p <port> <host> 'gerrit stream-events'
+--
DESCRIPTION
-----------
diff --git a/Documentation/cmd-suexec.txt b/Documentation/cmd-suexec.txt
index 7b128fa..73d2501 100644
--- a/Documentation/cmd-suexec.txt
+++ b/Documentation/cmd-suexec.txt
@@ -7,7 +7,7 @@
SYNOPSIS
--------
-[verse]
+--
'ssh' -p <port>
-i SITE_PATH/etc/ssh_host_rsa_key
'"Gerrit Code Review@localhost"'
@@ -16,6 +16,7 @@
[--from HOST:PORT]
[--]
[COMMAND]
+--
DESCRIPTION
-----------
diff --git a/Documentation/cmd-test-submit-rule.txt b/Documentation/cmd-test-submit-rule.txt
index 466182c..d75b21a 100644
--- a/Documentation/cmd-test-submit-rule.txt
+++ b/Documentation/cmd-test-submit-rule.txt
@@ -7,11 +7,12 @@
SYNOPSIS
--------
-[verse]
+--
'ssh' -p <port> <host> 'gerrit test-submit rule'
[-s]
[--no-filters]
CHANGE
+--
DESCRIPTION
-----------
diff --git a/Documentation/cmd-test-submit-type.txt b/Documentation/cmd-test-submit-type.txt
index 2b8790c..96ef3b1 100644
--- a/Documentation/cmd-test-submit-type.txt
+++ b/Documentation/cmd-test-submit-type.txt
@@ -7,11 +7,12 @@
SYNOPSIS
--------
-[verse]
+--
'ssh' -p <port> <host> 'gerrit test-submit type'
[-s]
[--no-filters]
CHANGE
+--
DESCRIPTION
-----------
diff --git a/Documentation/cmd-version.txt b/Documentation/cmd-version.txt
index 806e28a..57c89ba 100644
--- a/Documentation/cmd-version.txt
+++ b/Documentation/cmd-version.txt
@@ -7,8 +7,9 @@
SYNOPSIS
--------
-[verse]
+--
'ssh' -p <port> <host> 'gerrit version'
+--
DESCRIPTION
-----------
diff --git a/Documentation/dev-inspector.txt b/Documentation/dev-inspector.txt
index 14177f8..3076308 100644
--- a/Documentation/dev-inspector.txt
+++ b/Documentation/dev-inspector.txt
@@ -7,7 +7,7 @@
SYNOPSIS
--------
-[verse]
+--
'java' -jar gerrit.war 'daemon'
-d <SITE_PATH>
[\--enable-httpd | \--disable-httpd]
@@ -15,6 +15,7 @@
[\--console-log]
[\--slave]
-s
+--
DESCRIPTION
-----------
diff --git a/Documentation/pgm-LocalUsernamesToLowerCase.txt b/Documentation/pgm-LocalUsernamesToLowerCase.txt
index f1d21f89..bac3dc0 100644
--- a/Documentation/pgm-LocalUsernamesToLowerCase.txt
+++ b/Documentation/pgm-LocalUsernamesToLowerCase.txt
@@ -8,8 +8,9 @@
SYNOPSIS
--------
-[verse]
+--
'java' -jar gerrit.war 'LocalUsernamesToLowerCase' -d <SITE_PATH>
+--
DESCRIPTION
-----------
diff --git a/Documentation/pgm-ScanTrackingIds.txt b/Documentation/pgm-ScanTrackingIds.txt
index 9e38032..cd4b139 100644
--- a/Documentation/pgm-ScanTrackingIds.txt
+++ b/Documentation/pgm-ScanTrackingIds.txt
@@ -7,8 +7,9 @@
SYNOPSIS
--------
-[verse]
+--
'java' -jar gerrit.war 'ScanTrackingIds' -d <SITE_PATH>
+--
DESCRIPTION
-----------
diff --git a/Documentation/pgm-daemon.txt b/Documentation/pgm-daemon.txt
index 18bd293..19743a5 100644
--- a/Documentation/pgm-daemon.txt
+++ b/Documentation/pgm-daemon.txt
@@ -7,7 +7,7 @@
SYNOPSIS
--------
-[verse]
+--
'java' -jar gerrit.war 'daemon'
-d <SITE_PATH>
[\--enable-httpd | \--disable-httpd]
@@ -17,6 +17,7 @@
[\--headless]
[\--init]
[-s]
+--
DESCRIPTION
-----------
diff --git a/Documentation/pgm-gsql.txt b/Documentation/pgm-gsql.txt
index a805036..0f9e5e4 100644
--- a/Documentation/pgm-gsql.txt
+++ b/Documentation/pgm-gsql.txt
@@ -7,8 +7,9 @@
SYNOPSIS
--------
-[verse]
+--
'java' -jar gerrit.war 'gsql' -d <SITE_PATH>
+--
DESCRIPTION
-----------
diff --git a/Documentation/pgm-init.txt b/Documentation/pgm-init.txt
index 8e48b30..78e2e33 100644
--- a/Documentation/pgm-init.txt
+++ b/Documentation/pgm-init.txt
@@ -7,13 +7,14 @@
SYNOPSIS
--------
-[verse]
+--
'java' -jar gerrit.war 'init'
-d <SITE_PATH>
[\--batch]
[\--no-auto-start]
[\--list-plugins]
[\--install-plugin=<PLUGIN_NAME>]
+--
DESCRIPTION
-----------
diff --git a/Documentation/pgm-prolog-shell.txt b/Documentation/pgm-prolog-shell.txt
index 7b273f5..850ee74 100644
--- a/Documentation/pgm-prolog-shell.txt
+++ b/Documentation/pgm-prolog-shell.txt
@@ -7,8 +7,9 @@
SYNOPSIS
--------
-[verse]
+--
'java' -jar gerrit.war 'prolog-shell' [-s FILE.pl ...]
+--
DESCRIPTION
-----------
diff --git a/Documentation/pgm-reindex.txt b/Documentation/pgm-reindex.txt
index f55c093..491b575 100644
--- a/Documentation/pgm-reindex.txt
+++ b/Documentation/pgm-reindex.txt
@@ -7,8 +7,9 @@
SYNOPSIS
--------
-[verse]
+--
'java' -jar gerrit.war 'reindex' [<OPTIONS>]
+--
DESCRIPTION
-----------
diff --git a/Documentation/pgm-rulec.txt b/Documentation/pgm-rulec.txt
index 356f555..e031bf8 100644
--- a/Documentation/pgm-rulec.txt
+++ b/Documentation/pgm-rulec.txt
@@ -7,8 +7,9 @@
SYNOPSIS
--------
-[verse]
+--
'java' -jar gerrit.war 'rulec' -d <SITE_PATH> [--all | <PROJECT>...]
+--
DESCRIPTION
-----------
diff --git a/Documentation/rest-api-access.txt b/Documentation/rest-api-access.txt
index b49f787..fd85f6f 100644
--- a/Documentation/rest-api-access.txt
+++ b/Documentation/rest-api-access.txt
@@ -12,8 +12,9 @@
[[list-access]]
List Access Rights
~~~~~~~~~~~~~~~~~~
-[verse]
+--
'GET /access/?project=link:rest-api-projects.html#project-name[\{project-name\}]'
+--
Lists the access rights for projects. The projects for which the access
rights should be returned must be specified as `project` options. The
diff --git a/Documentation/rest-api-accounts.txt b/Documentation/rest-api-accounts.txt
index f72c154..e558f95 100644
--- a/Documentation/rest-api-accounts.txt
+++ b/Documentation/rest-api-accounts.txt
@@ -12,8 +12,9 @@
[[get-account]]
Get Account
~~~~~~~~~~~
-[verse]
+--
'GET /accounts/link:#account-id[\{account-id\}]'
+--
Returns an account as an link:#account-info[AccountInfo] entity.
@@ -40,8 +41,9 @@
[[create-account]]
Create Account
~~~~~~~~~~~~~~
-[verse]
+--
'PUT /accounts/link:#username[\{username\}]'
+--
Creates a new account.
@@ -84,8 +86,9 @@
[[get-account-name]]
Get Account Name
~~~~~~~~~~~~~~~~
-[verse]
+--
'GET /accounts/link:#account-id[\{account-id\}]/name'
+--
Retrieves the full name of an account.
@@ -109,8 +112,9 @@
[[set-account-name]]
Set Account Name
~~~~~~~~~~~~~~~~
-[verse]
+--
'PUT /accounts/link:#account-id[\{account-id\}]/name'
+--
Sets the full name of an account.
@@ -147,8 +151,9 @@
[[delete-account-name]]
Delete Account Name
~~~~~~~~~~~~~~~~~~~
-[verse]
+--
'DELETE /accounts/link:#account-id[\{account-id\}]/name'
+--
Deletes the name of an account.
@@ -165,8 +170,9 @@
[[get-username]]
Get Username
~~~~~~~~~~~~
-[verse]
+--
'GET /accounts/link:#account-id[\{account-id\}]/username'
+--
Retrieves the username of an account.
@@ -190,8 +196,9 @@
[[get-active]]
Get Active
~~~~~~~~~~
-[verse]
+--
'GET /accounts/link:#account-id[\{account-id\}]/active'
+--
Checks if an account is active.
@@ -214,8 +221,9 @@
[[set-active]]
Set Active
~~~~~~~~~~
-[verse]
+--
'PUT /accounts/link:#account-id[\{account-id\}]/active'
+--
Sets the account state to active.
@@ -234,8 +242,9 @@
[[delete-active]]
Delete Active
~~~~~~~~~~~~~
-[verse]
+--
'DELETE /accounts/link:#account-id[\{account-id\}]/active'
+--
Sets the account state to inactive.
@@ -254,8 +263,9 @@
[[get-http-password]]
Get HTTP Password
~~~~~~~~~~~~~~~~~
-[verse]
+--
'GET /accounts/link:#account-id[\{account-id\}]/password.http'
+--
Retrieves the HTTP password of an account.
@@ -279,8 +289,9 @@
[[set-http-password]]
Set/Generate HTTP Password
~~~~~~~~~~~~~~~~~~~~~~~~~~
-[verse]
+--
'PUT /accounts/link:#account-id[\{account-id\}]/password.http'
+--
Sets/Generates the HTTP password of an account.
@@ -315,8 +326,9 @@
[[delete-http-password]]
Delete HTTP Password
~~~~~~~~~~~~~~~~~~~~
-[verse]
+--
'DELETE /accounts/link:#account-id[\{account-id\}]/password.http'
+--
Deletes the HTTP password of an account.
@@ -333,8 +345,9 @@
[[list-account-emails]]
List Account Emails
~~~~~~~~~~~~~~~~~~~
-[verse]
+--
'GET /accounts/link:#account-id[\{account-id\}]/emails'
+--
Returns the email addresses that are configured for the specified user.
@@ -367,8 +380,9 @@
[[get-account-email]]
Get Account Email
~~~~~~~~~~~~~~~~~
-[verse]
+--
'GET /accounts/link:#account-id[\{account-id\}]/emails/link:#email-id[\{email-id\}]'
+--
Retrieves an email address of a user.
@@ -396,8 +410,9 @@
[[create-account-email]]
Create Account Email
~~~~~~~~~~~~~~~~~~~~
-[verse]
+--
'PUT /accounts/link:#account-id[\{account-id\}]/emails/link:#email-id[\{email-id\}]'
+--
Registers a new email address for the user. A verification email is
sent with a link that needs to be visited to confirm the email address,
@@ -434,8 +449,9 @@
[[delete-account-email]]
Delete Account Email
~~~~~~~~~~~~~~~~~~~~
-[verse]
+--
'DELETE /accounts/link:#account-id[\{account-id\}]/emails/link:#email-id[\{email-id\}]'
+--
Deletes an email address of an account.
@@ -452,8 +468,9 @@
[[set-preferred-email]]
Set Preferred Email
~~~~~~~~~~~~~~~~~~~
-[verse]
+--
'PUT /accounts/link:#account-id[\{account-id\}]/emails/link:#email-id[\{email-id\}]/preferred'
+--
Sets an email address as preferred email address for an account.
@@ -473,8 +490,9 @@
[[list-ssh-keys]]
List SSH Keys
~~~~~~~~~~~~~
-[verse]
+--
'GET /accounts/link:#account-id[\{account-id\}]/sshkeys'
+--
Returns the SSH keys of an account.
@@ -508,8 +526,9 @@
[[get-ssh-key]]
Get SSH Key
~~~~~~~~~~~
-[verse]
+--
'GET /accounts/link:#account-id[\{account-id\}]/sshkeys/link:#ssh-key-id[\{ssh-key-id\}]'
+--
Retrieves an SSH key of a user.
@@ -541,8 +560,9 @@
[[add-ssh-key]]
Add SSH Key
~~~~~~~~~~~
-[verse]
+--
'POST /accounts/link:#account-id[\{account-id\}]/sshkeys'
+--
Adds an SSH key for a user.
@@ -579,8 +599,9 @@
[[delete-ssh-key]]
Delete SSH Key
~~~~~~~~~~~~~~
-[verse]
+--
'DELETE /accounts/link:#account-id[\{account-id\}]/sshkeys/link:#ssh-key-id[\{ssh-key-id\}]'
+--
Deletes an SSH key of a user.
@@ -597,8 +618,9 @@
[[list-account-capabilities]]
List Account Capabilities
~~~~~~~~~~~~~~~~~~~~~~~~~
-[verse]
+--
'GET /accounts/link:#account-id[\{account-id\}]/capabilities'
+--
Returns the global capabilities that are enabled for the specified
user.
@@ -702,8 +724,9 @@
[[check-account-capability]]
Check Account Capability
~~~~~~~~~~~~~~~~~~~~~~~~
-[verse]
+--
'GET /accounts/link:#account-id[\{account-id\}]/capabilities/link:#capability-id[\{capability-id\}]'
+--
Checks if a user has a certain global capability.
@@ -732,8 +755,9 @@
[[list-groups]]
List Groups
~~~~~~~~~~~
-[verse]
+--
'GET /accounts/link:#account-id[\{account-id\}]/groups/'
+--
Lists all groups that contain the specified user as a member.
@@ -794,8 +818,9 @@
[[get-avatar]]
Get Avatar
~~~~~~~~~~
-[verse]
+--
'GET /accounts/link:#account-id[\{account-id\}]/avatar'
+--
Retrieves the avatar image of the user.
@@ -818,8 +843,9 @@
[[get-avatar-change-url]]
Get Avatar Change URL
~~~~~~~~~~~~~~~~~~~~~
-[verse]
+--
'GET /accounts/link:#account-id[\{account-id\}]/avatar.change.url'
+--
Retrieves the URL where the user can change the avatar image.
@@ -840,8 +866,9 @@
[[get-diff-preferences]]
Get Diff Preferences
~~~~~~~~~~~~~~~~~~~~
-[verse]
+--
'GET /accounts/link:#account-id[\{account-id\}]/preferences.diff'
+--
Retrieves the diff preferences of a user.
@@ -875,8 +902,9 @@
[[set-diff-preferences]]
Set Diff Preferences
~~~~~~~~~~~~~~~~~~~~
-[verse]
+--
'PUT /accounts/link:#account-id[\{account-id\}]/preferences.diff'
+--
Sets the diff preferences of a user.
@@ -927,8 +955,9 @@
[[get-starred-changes]]
Get Starred Changes
~~~~~~~~~~~~~~~~~~~
-[verse]
+--
'GET /accounts/link:#account-id[\{account-id\}]/starred.changes'
+--
Gets the changes starred by the identified user account. This
URL endpoint is functionally identical to the changes query
@@ -971,8 +1000,9 @@
[[star-change]]
Star Change
~~~~~~~~~~~
-[verse]
+--
'PUT /accounts/link:#account-id[\{account-id\}]/starred.changes/link:rest-api-changes.html#change-id[\{change-id\}]'
+--
Star a change. Starred changes are returned for the search query
`is:starred` or `starredby:USER` and automatically notify the user
@@ -991,8 +1021,9 @@
[[unstar-change]]
Unstar Change
~~~~~~~~~~~~~
-[verse]
+--
'DELETE /accounts/link:#account-id[\{account-id\}]/starred.changes/link:rest-api-changes#change-id[\{change-id\}]'
+--
Unstar a change. Removes the starred flag, stopping notifications.
diff --git a/Documentation/rest-api-changes.txt b/Documentation/rest-api-changes.txt
index 9ed8be0..79e1b79 100644
--- a/Documentation/rest-api-changes.txt
+++ b/Documentation/rest-api-changes.txt
@@ -12,8 +12,9 @@
[[list-changes]]
Query Changes
~~~~~~~~~~~~~
-[verse]
+--
'GET /changes/'
+--
Queries changes visible to the caller. The query string must be
provided by the `q` parameter. The `n` parameter can be used to limit
@@ -361,8 +362,9 @@
[[get-change]]
Get Change
~~~~~~~~~~
-[verse]
+--
'GET /changes/link:#change-id[\{change-id\}]'
+--
Retrieves a change.
@@ -408,8 +410,9 @@
[[get-change-detail]]
Get Change Detail
~~~~~~~~~~~~~~~~~
-[verse]
+--
'GET /changes/link:#change-id[\{change-id\}]/detail'
+--
Retrieves a change with link:#labels[labels], link:#detailed-labels[
detailed labels], link:#detailed-accounts[detailed accounts], and
@@ -576,8 +579,9 @@
[[get-topic]]
Get Topic
~~~~~~~~~
-[verse]
+--
'GET /changes/link:#change-id[\{change-id\}]/topic'
+--
Retrieves the topic of a change.
@@ -601,8 +605,9 @@
[[set-topic]]
Set Topic
~~~~~~~~~
-[verse]
+--
'PUT /changes/link:#change-id[\{change-id\}]/topic'
+--
Sets the topic of a change.
@@ -636,8 +641,9 @@
[[delete-topic]]
Delete Topic
~~~~~~~~~~~~
-[verse]
+--
'DELETE /changes/link:#change-id[\{change-id\}]/topic'
+--
Deletes the topic of a change.
@@ -661,8 +667,9 @@
[[abandon-change]]
Abandon Change
~~~~~~~~~~~~~~
-[verse]
+--
'POST /changes/link:#change-id[\{change-id\}]/abandon'
+--
Abandons a change.
@@ -719,8 +726,9 @@
[[restore-change]]
Restore Change
~~~~~~~~~~~~~~
-[verse]
+--
'POST /changes/link:#change-id[\{change-id\}]/restore'
+--
Restores a change.
@@ -777,8 +785,9 @@
[[rebase-change]]
Rebase Change
~~~~~~~~~~~~~
-[verse]
+--
'POST /changes/link:#change-id[\{change-id\}]/rebase'
+--
Rebases a change.
@@ -866,8 +875,9 @@
[[revert-change]]
Revert Change
~~~~~~~~~~~~~
-[verse]
+--
'POST /changes/link:#change-id[\{change-id\}]/revert'
+--
Reverts a change.
@@ -924,8 +934,9 @@
[[submit-change]]
Submit Change
~~~~~~~~~~~~~
-[verse]
+--
'POST /changes/link:#change-id[\{change-id\}]/submit'
+--
Submits a change.
@@ -987,8 +998,9 @@
[[publish-draft-change]]
Publish Draft Change
~~~~~~~~~~~~~~~~~~~~
-[verse]
+--
'POST /changes/link:#change-id[\{change-id\}]/publish'
+--
Publishes a draft change.
@@ -1006,8 +1018,9 @@
[[delete-draft-change]]
Delete Draft Change
~~~~~~~~~~~~~~~~~~~
-[verse]
+--
'DELETE /changes/link:#change-id[\{change-id\}]'
+--
Deletes a draft change.
@@ -1025,8 +1038,9 @@
[[get-included-in]]
Get Included In
~~~~~~~~~~~~~~~
-[verse]
+--
'GET /changes/link:#change-id[\{change-id\}]/in'
+--
Retrieves the branches and tags in which a change is included. As result
an link:#included-in-info[IncludedInInfo] entity is returned.
@@ -1059,8 +1073,9 @@
[[list-reviewers]]
List Reviewers
~~~~~~~~~~~~~~
-[verse]
+--
'GET /changes/link:#change-id[\{change-id\}]/reviewers/'
+--
Lists the reviewers of a change.
@@ -1105,8 +1120,9 @@
[[suggest-reviewers]]
Suggest Reviewers
~~~~~~~~~~~~~~~~~
-[verse]
+--
'GET /changes/link:#change-id[\{change-id\}]/suggest_reviewers?q=J&n=5'
+--
Suggest the reviewers for a given query `q` and result limit `n`. If result
limit is not passed, then the default 10 is used.
@@ -1147,8 +1163,9 @@
[[get-reviewer]]
Get Reviewer
~~~~~~~~~~~~
-[verse]
+--
'GET /changes/link:#change-id[\{change-id\}]/reviewers/link:rest-api-accounts.html#account-id[\{account-id\}]'
+--
Retrieves a reviewer of a change.
@@ -1182,8 +1199,9 @@
[[add-reviewer]]
Add Reviewer
~~~~~~~~~~~~
-[verse]
+--
'POST /changes/link:#change-id[\{change-id\}]/reviewers'
+--
Adds one user or all members of one group as reviewer to the change.
@@ -1273,8 +1291,9 @@
[[delete-reviewer]]
Delete Reviewer
~~~~~~~~~~~~~~~
-[verse]
+--
'DELETE /changes/link:#change-id[\{change-id\}]/reviewers/link:rest-api-accounts.html#account-id[\{account-id\}]'
+--
Deletes a reviewer from a change.
@@ -1295,8 +1314,9 @@
[[get-commit]]
Get Commit
~~~~~~~~~~
-[verse]
+--
'GET /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/commit'
+--
Retrieves a parsed commit of a revision.
@@ -1344,8 +1364,9 @@
[[get-review]]
Get Review
~~~~~~~~~~
-[verse]
+--
'GET /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/review'
+--
Retrieves a review of a revision.
@@ -1477,8 +1498,9 @@
[[set-review]]
Set Review
~~~~~~~~~~
-[verse]
+--
'POST /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/review'
+--
Sets a review on a revision.
@@ -1530,8 +1552,9 @@
[[rebase-revision]]
Rebase Revision
~~~~~~~~~~~~~~~
-[verse]
+--
'POST /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/rebase'
+--
Rebases a revision.
@@ -1619,8 +1642,9 @@
[[submit-revision]]
Submit Revision
~~~~~~~~~~~~~~~
-[verse]
+--
'POST /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/submit'
+--
Submits a revision.
@@ -1669,8 +1693,9 @@
[[publish-draft-revision]]
Publish Draft Revision
~~~~~~~~~~~~~~~~~~~~~~
-[verse]
+--
'POST /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/publish'
+--
Publishes a draft revision.
@@ -1688,8 +1713,9 @@
[[delete-draft-revision]]
Delete Draft Revision
~~~~~~~~~~~~~~~~~~~~~
-[verse]
+--
'DELETE /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]'
+--
Deletes a draft revision.
@@ -1707,8 +1733,9 @@
[[get-patch]]
Get Patch
~~~~~~~~~
-[verse]
+--
'GET /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/patch'
+--
Gets the formatted patch for one revision.
@@ -1742,8 +1769,9 @@
[[get-mergeable]]
Get Mergeable
~~~~~~~~~~~~~
-[verse]
+--
'GET /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/mergeable'
+--
Gets the method the server will use to submit (merge) the change and
an indicator if the change is currently mergeable.
@@ -1769,8 +1797,9 @@
[[get-submit-type]]
Get Submit Type
~~~~~~~~~~~~~~~
-[verse]
+--
'GET /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/submit_type'
+--
Gets the method the server will use to submit (merge) the change.
@@ -1792,8 +1821,9 @@
[[test-submit-type]]
Test Submit Type
~~~~~~~~~~~~~~~~
-[verse]
+--
'POST /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/test.submit_type'
+--
Tests the submit_type Prolog rule in the project, or the one given.
@@ -1823,8 +1853,9 @@
[[test-submit-rule]]
Test Submit Rule
~~~~~~~~~~~~~~~~
-[verse]
+--
'POST /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/test.submit_rule'
+--
Tests the submit_rule Prolog rule in the project, or the one given.
@@ -1865,8 +1896,9 @@
[[list-drafts]]
List Drafts
~~~~~~~~~~~
-[verse]
+--
'GET /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/drafts/'
+--
Lists the draft comments of a revision that belong to the calling
user.
@@ -1911,8 +1943,9 @@
[[create-draft]]
Create Draft
~~~~~~~~~~~~
-[verse]
+--
'PUT /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/drafts'
+--
Creates a draft comment on a revision.
@@ -1954,8 +1987,9 @@
[[get-draft]]
Get Draft
~~~~~~~~~
-[verse]
+--
'GET /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/drafts/link:#draft-id[\{draft-id\}]'
+--
Retrieves a draft comment of a revision that belongs to the calling
user.
@@ -1988,8 +2022,9 @@
[[update-draft]]
Update Draft
~~~~~~~~~~~~
-[verse]
+--
'PUT /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/drafts/link:#draft-id[\{draft-id\}]'
+--
Updates a draft comment on a revision.
@@ -2031,8 +2066,9 @@
[[delete-draft]]
Delete Draft
~~~~~~~~~~~~
-[verse]
+--
'DELETE /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/drafts/link:#draft-id[\{draft-id\}]'
+--
Deletes a draft comment from a revision.
@@ -2049,8 +2085,9 @@
[[list-comments]]
List Comments
~~~~~~~~~~~~~
-[verse]
+--
'GET /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/comments/'
+--
Lists the published comments of a revision.
@@ -2104,8 +2141,9 @@
[[get-comment]]
Get Comment
~~~~~~~~~~~
-[verse]
+--
'GET /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/comments/link:#comment-id[\{comment-id\}]'
+--
Retrieves a published comment of a revision.
@@ -2142,8 +2180,9 @@
[[list-files]]
List Files
~~~~~~~~~~
-[verse]
+--
'GET /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/files/'
+--
Lists the files that were modified, added or deleted in a revision.
@@ -2200,8 +2239,9 @@
[[get-content]]
Get Content
~~~~~~~~~~~
-[verse]
+--
'GET /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/files/link:#file-id[\{file-id\}]/content'
+--
Gets the content of a file from a certain revision.
@@ -2224,8 +2264,9 @@
[[get-diff]]
Get Diff
~~~~~~~~
-[verse]
+--
'GET /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/files/link:#file-id[\{file-id\}]/diff'
+--
Gets the diff of a file from a certain revision.
@@ -2390,8 +2431,9 @@
[[set-reviewed]]
Set Reviewed
~~~~~~~~~~~~
-[verse]
+--
'PUT /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/files/link:#file-id[\{file-id\}]/reviewed'
+--
Marks a file of a revision as reviewed by the calling user.
@@ -2411,8 +2453,9 @@
[[delete-reviewed]]
Delete Reviewed
~~~~~~~~~~~~~~~
-[verse]
+--
'DELETE /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/files/link:#file-id[\{file-id\}]/reviewed'
+--
Deletes the reviewed flag of the calling user from a file of a revision.
@@ -2429,8 +2472,9 @@
[[cherry-pick]]
Cherry Pick Revision
~~~~~~~~~~~~~~~~~~~~
-[verse]
+--
'POST /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/cherrypick'
+--
Cherry picks a revision to a destination branch.
@@ -2480,8 +2524,9 @@
[[message]]
Edit Commit Message
~~~~~~~~~~~~~~~~~~~
-[verse]
+--
'POST /changes/link:#change-id[\{change-id\}]/revisions/link:#revision-id[\{revision-id\}]/message'
+--
Edit commit message.
diff --git a/Documentation/rest-api-config.txt b/Documentation/rest-api-config.txt
index 9a512b8..af290c9 100644
--- a/Documentation/rest-api-config.txt
+++ b/Documentation/rest-api-config.txt
@@ -12,8 +12,9 @@
[[get-version]]
Get Version
~~~~~~~~~~~
-[verse]
+--
'GET /config/server/version'
+--
Returns the version of the Gerrit server.
@@ -34,8 +35,9 @@
[[list-capabilities]]
List Capabilities
~~~~~~~~~~~~~~~~~
-[verse]
+--
'GET /config/server/capabilities'
+--
Lists the capabilities that are available in the system. There are two
kinds of capabilities: core and plugin-owned capabilities.
@@ -138,8 +140,9 @@
[[get-top-menus]]
Get Top Menus
~~~~~~~~~~~~~
-[verse]
+--
'GET /config/server/top-menus'
+--
Returns the list of additional top menu entries.
diff --git a/Documentation/rest-api-documentation.txt b/Documentation/rest-api-documentation.txt
index 9030fac..0defe6d 100644
--- a/Documentation/rest-api-documentation.txt
+++ b/Documentation/rest-api-documentation.txt
@@ -19,8 +19,9 @@
[[search-documentation]]
Search Documentation
~~~~~~~~~~~~~~~~~~~~
-[verse]
+--
'GET /Documentation/'
+--
With `q` parameter, search our documentation index for the terms.
diff --git a/Documentation/rest-api-groups.txt b/Documentation/rest-api-groups.txt
index e96607c..ed9fcc7 100644
--- a/Documentation/rest-api-groups.txt
+++ b/Documentation/rest-api-groups.txt
@@ -12,8 +12,9 @@
[[list-groups]]
List Groups
~~~~~~~~~~~
-[verse]
+--
'GET /groups/'
+--
Lists the groups accessible by the caller. This is the same as
using the link:cmd-ls-groups.html[ls-groups] command over SSH,
@@ -168,8 +169,9 @@
[[get-group]]
Get Group
~~~~~~~~~
-[verse]
+--
'GET /groups/link:#group-id[\{group-id\}]'
+--
Retrieves a group.
@@ -205,8 +207,9 @@
[[create-group]]
Create Group
~~~~~~~~~~~~
-[verse]
+--
'PUT /groups/link:#group-name[\{group-name\}]'
+--
Creates a new Gerrit internal group.
@@ -257,8 +260,9 @@
[[get-group-detail]]
Get Group Detail
~~~~~~~~~~~~~~~~
-[verse]
+--
'GET /groups/link:#group-id[\{group-id\}]/detail'
+--
Retrieves a group with the direct link:#members[members] and the
directly link:#includes[included groups].
@@ -310,8 +314,9 @@
[[get-group-name]]
Get Group Name
~~~~~~~~~~~~~~
-[verse]
+--
'GET /groups/link:#group-id[\{group-id\}]/name'
+--
Retrieves the name of a group.
@@ -333,8 +338,9 @@
[[rename-group]]
Rename Group
~~~~~~~~~~~~
-[verse]
+--
'PUT /groups/link:#group-id[\{group-id\}]/name'
+--
Renames a Gerrit internal group.
@@ -368,8 +374,9 @@
[[get-group-description]]
Get Group Description
~~~~~~~~~~~~~~~~~~~~~
-[verse]
+--
'GET /groups/link:#group-id[\{group-id\}]/description'
+--
Retrieves the description of a group.
@@ -393,8 +400,9 @@
[[set-group-description]]
Set Group Description
~~~~~~~~~~~~~~~~~~~~~
-[verse]
+--
'PUT /groups/link:#group-id[\{group-id\}]/description'
+--
Sets the description of a Gerrit internal group.
@@ -427,8 +435,9 @@
[[delete-group-description]]
Delete Group Description
~~~~~~~~~~~~~~~~~~~~~~~~
-[verse]
+--
'DELETE /groups/link:#group-id[\{group-id\}]/description'
+--
Deletes the description of a Gerrit internal group.
@@ -445,8 +454,9 @@
[[get-group-options]]
Get Group Options
~~~~~~~~~~~~~~~~~
-[verse]
+--
'GET /groups/link:#group-id[\{group-id\}]/options'
+--
Retrieves the options of a group.
@@ -473,8 +483,9 @@
[[set-group-options]]
Set Group Options
~~~~~~~~~~~~~~~~~
-[verse]
+--
'PUT /groups/link:#group-id[\{group-id\}]/options'
+--
Sets the options of a Gerrit internal group.
@@ -509,8 +520,9 @@
[[get-group-owner]]
Get Group Owner
~~~~~~~~~~~~~~~
-[verse]
+--
'GET /groups/link:#group-id[\{group-id\}]/owner'
+--
Retrieves the owner group of a Gerrit internal group.
@@ -546,8 +558,9 @@
[[set-group-owner]]
Set Group Owner
~~~~~~~~~~~~~~~
-[verse]
+--
'PUT /groups/link:#group-id[\{group-id\}]/owner'
+--
Sets the owner group of a Gerrit internal group.
@@ -597,8 +610,9 @@
[[group-members]]
List Group Members
~~~~~~~~~~~~~~~~~~
-[verse]
+--
'GET /groups/link:#group-id[\{group-id\}]/members/'
+--
Lists the direct members of a Gerrit internal group.
@@ -682,8 +696,9 @@
[[get-group-member]]
Get Group Member
~~~~~~~~~~~~~~~~
-[verse]
+--
'GET /groups/link:#group-id[\{group-id\}]/members/link:rest-api-accounts.html#account-id[\{account-id\}]'
+--
Retrieves a group member.
@@ -713,8 +728,9 @@
[[add-group-member]]
Add Group Member
~~~~~~~~~~~~~~~~
-[verse]
+--
'PUT /groups/link:#group-id[\{group-id\}]/members/link:rest-api-accounts.html#account-id[\{account-id\}]'
+--
Adds a user as member to a Gerrit internal group.
@@ -746,13 +762,15 @@
Add Group Members
~~~~~~~~~~~~~~~~~
-[verse]
+--
'POST /groups/link:#group-id[\{group-id\}]/members'
+--
OR
-[verse]
+--
'POST /groups/link:#group-id[\{group-id\}]/members.add'
+--
Adds one or several users to a Gerrit internal group.
@@ -806,8 +824,9 @@
[[delete-group-member]]
Delete Group Member
~~~~~~~~~~~~~~~~~~~
-[verse]
+--
'DELETE /groups/link:#group-id[\{group-id\}]/members/link:rest-api-accounts.html#account-id[\{account-id\}]'
+--
Deletes a user from a Gerrit internal group.
@@ -824,8 +843,9 @@
[[delete-group-members]]
Delete Group Members
~~~~~~~~~~~~~~~~~~~~
-[verse]
+--
'POST /groups/link:#group-id[\{group-id\}]/members.delete'
+--
Delete one or several users from a Gerrit internal group.
@@ -857,8 +877,9 @@
[[included-groups]]
List Included Groups
~~~~~~~~~~~~~~~~~~~~
-[verse]
+--
'GET /groups/link:#group-id[\{group-id\}]/groups/'
+--
Lists the directly included groups of a group.
@@ -895,8 +916,9 @@
[[get-included-group]]
Get Included Group
~~~~~~~~~~~~~~~~~~
-[verse]
+--
'GET /groups/link:#group-id[\{group-id\}]/groups/link:#group-id[\{group-id\}]'
+--
Retrieves an included group.
@@ -931,8 +953,9 @@
[[include-group]]
Include Group
~~~~~~~~~~~~~
-[verse]
+--
'PUT /groups/link:#group-id[\{group-id\}]/groups/link:#group-id[\{group-id\}]'
+--
Includes an internal or external group into a Gerrit internal group.
External groups must be specified using the UUID.
@@ -971,13 +994,15 @@
[[include-groups]]
Include Groups
~~~~~~~~~~~~~~
-[verse]
+--
'POST /groups/link:#group-id[\{group-id\}]/groups'
+--
OR
-[verse]
+--
'POST /groups/link:#group-id[\{group-id\}]/groups.add'
+--
Includes one or several groups into a Gerrit internal group.
@@ -1040,8 +1065,9 @@
[[delete-included-group]]
Delete Included Group
~~~~~~~~~~~~~~~~~~~~~
-[verse]
+--
'DELETE /groups/link:#group-id[\{group-id\}]/groups/link:#group-id[\{group-id\}]'
+--
Deletes an included group from a Gerrit internal group.
@@ -1058,8 +1084,9 @@
[[delete-included-groups]]
Delete Included Groups
~~~~~~~~~~~~~~~~~~~~~~
-[verse]
+--
'POST /groups/link:#group-id[\{group-id\}]/groups.delete'
+--
Delete one or several included groups from a Gerrit internal group.
diff --git a/Documentation/rest-api-plugins.txt b/Documentation/rest-api-plugins.txt
index f5b6809..adfd3e27 100644
--- a/Documentation/rest-api-plugins.txt
+++ b/Documentation/rest-api-plugins.txt
@@ -19,8 +19,9 @@
[[list-plugins]]
List Plugins
~~~~~~~~~~~~
-[verse]
+--
'GET /plugins/'
+--
Lists the plugins installed on the Gerrit server. Only the enabled
plugins are returned unless the `all` option is specified.
@@ -59,8 +60,9 @@
[[install-plugin]]
Install Plugin
~~~~~~~~~~~~~~
-[verse]
+--
'PUT /plugins/link:#plugin-id[\{plugin-id\}]'
+--
Installs a new plugin on the Gerrit server. If a plugin with the
specified name already exists it is overwritten. Note: if the plugin
@@ -110,8 +112,9 @@
[[get-plugin-status]]
Get Plugin Status
~~~~~~~~~~~~~~~~~
-[verse]
+--
'GET /plugins/link:#plugin-id[\{plugin-id\}]/gerrit~status'
+--
Retrieves the status of a plugin on the Gerrit server.
@@ -140,8 +143,9 @@
[[enable-plugin]]
Enable Plugin
~~~~~~~~~~~~~
-[verse]
+--
'POST /plugins/link:#plugin-id[\{plugin-id\}]/gerrit~enable'
+--
Enables a plugin on the Gerrit server.
@@ -170,13 +174,15 @@
[[disable-plugin]]
Disable Plugin
~~~~~~~~~~~~~~
-[verse]
+--
'POST /plugins/link:#plugin-id[\{plugin-id\}]/gerrit~disable'
+--
OR
-[verse]
+--
'DELETE /plugins/link:#plugin-id[\{plugin-id\}]'
+--
Disables a plugin on the Gerrit server.
@@ -206,8 +212,9 @@
[[reload-plugin]]
Reload Plugin
~~~~~~~~~~~~~
-[verse]
+--
'POST /plugins/link:#plugin-id[\{plugin-id\}]/gerrit~reload'
+--
Reloads a plugin on the Gerrit server.
diff --git a/Documentation/rest-api-projects.txt b/Documentation/rest-api-projects.txt
index c2e937a..4012f74 100644
--- a/Documentation/rest-api-projects.txt
+++ b/Documentation/rest-api-projects.txt
@@ -12,8 +12,9 @@
[[list-projects]]
List Projects
~~~~~~~~~~~~~
-[verse]
+--
'GET /projects/'
+--
Lists the projects accessible by the caller. This is the same as
using the link:cmd-ls-projects.html[ls-projects] command over SSH,
@@ -97,8 +98,9 @@
[[get-project]]
Get Project
~~~~~~~~~~~
-[verse]
+--
'GET /projects/link:#project-name[\{project-name\}]'
+--
Retrieves a project.
@@ -129,8 +131,9 @@
[[create-project]]
Create Project
~~~~~~~~~~~~~~
-[verse]
+--
'PUT /projects/link:#project-name[\{project-name\}]'
+--
Creates a new project.
@@ -173,8 +176,9 @@
[[get-project-description]]
Get Project Description
~~~~~~~~~~~~~~~~~~~~~~~
-[verse]
+--
'GET /projects/link:#project-name[\{project-name\}]/description'
+--
Retrieves the description of a project.
@@ -198,8 +202,9 @@
[[set-project-description]]
Set Project Description
~~~~~~~~~~~~~~~~~~~~~~~
-[verse]
+--
'PUT /projects/link:#project-name[\{project-name\}]/description'
+--
Sets the description of a project.
@@ -234,8 +239,9 @@
[[delete-project-description]]
Delete Project Description
~~~~~~~~~~~~~~~~~~~~~~~~~~
-[verse]
+--
'DELETE /projects/link:#project-name[\{project-name\}]/description'
+--
Deletes the description of a project.
@@ -260,8 +266,9 @@
[[get-project-parent]]
Get Project Parent
~~~~~~~~~~~~~~~~~~
-[verse]
+--
'GET /projects/link:#project-name[\{project-name\}]/parent'
+--
Retrieves the name of a project's parent project. For the
`All-Projects` root project an empty string is returned.
@@ -284,8 +291,9 @@
[[set-project-parent]]
Set Project Parent
~~~~~~~~~~~~~~~~~~
-[verse]
+--
'PUT /projects/link:#project-name[\{project-name\}]/parent'
+--
Sets the parent project for a project.
@@ -318,8 +326,9 @@
[[get-head]]
Get HEAD
~~~~~~~~
-[verse]
+--
'GET /projects/link:#project-name[\{project-name\}]/HEAD'
+--
Retrieves for a project the name of the branch to which `HEAD` points.
@@ -341,8 +350,9 @@
[[set-head]]
Set HEAD
~~~~~~~~
-[verse]
+--
'PUT /projects/link:#project-name[\{project-name\}]/HEAD'
+--
Sets `HEAD` for a project.
@@ -374,8 +384,9 @@
[[get-repository-statistics]]
Get Repository Statistics
~~~~~~~~~~~~~~~~~~~~~~~~~
-[verse]
+--
'GET /projects/link:#project-name[\{project-name\}]/statistics.git'
+--
Return statistics for the repository of a project.
@@ -408,8 +419,9 @@
[[get-config]]
Get Config
~~~~~~~~~~
-[verse]
+--
'GET /projects/link:#project-name[\{project-name\}]/config'
+--
Gets some configuration information about a project. Note that this
config info is not simply the contents of `project.config`; it generally
@@ -476,8 +488,9 @@
[[set-config]]
Set Config
~~~~~~~~~~
-[verse]
+--
'PUT /projects/link:#project-name[\{project-name\}]/config'
+--
Sets the configuration of a project.
@@ -547,8 +560,9 @@
[[run-gc]]
Run GC
~~~~~~
-[verse]
+--
'POST /projects/link:#project-name[\{project-name\}]/gc'
+--
Run the Git garbage collection for the repository of a project.
@@ -598,8 +612,9 @@
[[list-branches]]
List Branches
~~~~~~~~~~~~~
-[verse]
+--
'GET /projects/link:#project-name[\{project-name\}]/branches/'
+--
List the branches of a project.
@@ -642,8 +657,9 @@
[[get-branch]]
Get Branch
~~~~~~~~~~
-[verse]
+--
'GET /projects/link:#project-name[\{project-name\}]/branches/link:#branch-id[\{branch-id\}]'
+--
Retrieves a branch of a project.
@@ -671,8 +687,9 @@
[[create-branch]]
Create Branch
~~~~~~~~~~~~~
-[verse]
+--
'PUT /projects/link:#project-name[\{project-name\}]/branches/link:#branch-id[\{branch-id\}]'
+--
Creates a new branch.
@@ -709,8 +726,9 @@
[[delete-branch]]
Delete Branch
~~~~~~~~~~~~~
-[verse]
+--
'DELETE /projects/link:#project-name[\{project-name\}]/branches/link:#branch-id[\{branch-id\}]'
+--
Deletes a branch.
@@ -731,8 +749,9 @@
[[list-child-projects]]
List Child Projects
~~~~~~~~~~~~~~~~~~~
-[verse]
+--
'GET /projects/link:#project-name[\{project-name\}]/children/'
+--
List the direct child projects of a project.
@@ -836,8 +855,9 @@
[[get-child-project]]
Get Child Project
~~~~~~~~~~~~~~~~~
-[verse]
+--
'GET /projects/link:#project-name[\{project-name\}]/children/link:#project-name[\{project-name\}]'
+--
Retrieves a child project. If a non-direct child project should be
retrieved the parameter `recursive` must be set.
@@ -873,8 +893,9 @@
[[list-dashboards]]
List Dashboards
~~~~~~~~~~~~~~~
-[verse]
+--
'GET /projects/link:#project-name[\{project-name\}]/dashboards/'
+--
List custom dashboards for a project.
@@ -927,8 +948,9 @@
[[get-dashboard]]
Get Dashboard
~~~~~~~~~~~~~
-[verse]
+--
'GET /projects/link:#project-name[\{project-name\}]/dashboards/link:#dashboard-id[\{dashboard-id\}]'
+--
Retrieves a project dashboard. The dashboard can be defined on that
project or be inherited from a parent project.
@@ -1010,8 +1032,9 @@
[[set-dashboard]]
Set Dashboard
~~~~~~~~~~~~~
-[verse]
+--
'PUT /projects/link:#project-name[\{project-name\}]/dashboards/link:#dashboard-id[\{dashboard-id\}]'
+--
Updates/Creates a project dashboard.
@@ -1066,8 +1089,9 @@
[[delete-dashboard]]
Delete Dashboard
~~~~~~~~~~~~~~~~
-[verse]
+--
'DELETE /projects/link:#project-name[\{project-name\}]/dashboards/link:#dashboard-id[\{dashboard-id\}]'
+--
Deletes a project dashboard.
