opendev/gerrit
Code Issues Proposed changes

Merge "Some more broken synopsis formattings in documentation"

Browse Source
This commit is contained in:
Saša Živkov 2016-07-08 14:07:44 +00:00 committed by Gerrit Code Review
commit fc332099e5
9 changed files with 57 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
Documentation/dev-inspector.txt
View File

@ -4,14 +4,15 @@
Gerrit Inspector - Interactive Jython environment for Gerrit
== SYNOPSIS
[verse]
--
'java' -jar gerrit.war 'daemon'
-d <SITE_PATH>
[\--enable-httpd | \--disable-httpd]
[\--enable-sshd | \--disable-sshd]
[\--console-log]
[\--slave]
-s
_java_ -jar gerrit.war _daemon_
-d <SITE_PATH>
[--enable-httpd | --disable-httpd]
[--enable-sshd | --disable-sshd]
[--console-log]
[--slave]
-s
--
== DESCRIPTION

5
Documentation/pgm-LocalUsernamesToLowerCase.txt
View File

@ -5,8 +5,11 @@ LocalUsernamesToLowerCase - Convert the local username of every
account to lower case
== SYNOPSIS
[verse]
--
'java' -jar gerrit.war 'LocalUsernamesToLowerCase' -d <SITE_PATH>
_java_ -jar gerrit.war _LocalUsernamesToLowerCase
-d <SITE_PATH>
[--threads]
--
== DESCRIPTION

4
Documentation/pgm-SwitchSecureStore.txt
View File

@ -4,8 +4,10 @@
SwitchSecureStore - Changes the currently used SecureStore implementation
== SYNOPSIS
[verse]
--
'java' -jar gerrit.war 'SwitchSecureStore' [<OPTIONS>]
_java_ -jar gerrit.war _SwitchSecureStore_
[--new-secure-store-lib]
--
== DESCRIPTION

19
Documentation/pgm-daemon.txt
View File

@ -4,16 +4,17 @@
daemon - Gerrit network server
== SYNOPSIS
[verse]
--
'java' -jar gerrit.war 'daemon'
-d <SITE_PATH>
[--enable-httpd | --disable-httpd]
[--enable-sshd | --disable-sshd]
[--console-log]
[--slave]
[--headless]
[--init]
[-s]
_java_ -jar gerrit.war _daemon_
-d <SITE_PATH>
[--enable-httpd | --disable-httpd]
[--enable-sshd | --disable-sshd]
[--console-log]
[--slave]
[--headless]
[--init]
[-s]
--
== DESCRIPTION

4
Documentation/pgm-gsql.txt
View File

@ -4,8 +4,10 @@
gsql - Administrative interface to idle database
== SYNOPSIS
[verse]
--
'java' -jar gerrit.war 'gsql' -d <SITE_PATH>
_java_ -jar gerrit.war _gsql_
-d <SITE_PATH>
--
== DESCRIPTION

25
Documentation/pgm-init.txt
View File

@ -4,19 +4,20 @@
init - Initialize/Upgrade a Gerrit server installation
== SYNOPSIS
[verse]
--
'java' -jar gerrit.war 'init'
-d <SITE_PATH>
[--batch]
[--no-auto-start]
[--skip-plugins]
[--list-plugins]
[--install-plugin=<PLUGIN_NAME>]
[--install-all-plugins]
[--secure-store-lib]
[--dev]
[--skip-all-downloads]
[--skip-download=<LIBRARY_NAME>]
_java_ -jar gerrit.war _init_
-d <SITE_PATH>
[--batch]
[--no-auto-start]
[--skip-plugins]
[--list-plugins]
[--install-plugin=<PLUGIN_NAME>]
[--install-all-plugins]
[--secure-store-lib]
[--dev]
[--skip-all-downloads]
[--skip-download=<LIBRARY_NAME>]
--
== DESCRIPTION

4
Documentation/pgm-prolog-shell.txt
View File

@ -4,8 +4,10 @@
prolog-shell - Simple interactive Prolog interpreter
== SYNOPSIS
[verse]
--
'java' -jar gerrit.war 'prolog-shell' [-s FILE.pl ...]
_java_ -jar gerrit.war _prolog-shell_
[-s FILE.pl ...]
--
== DESCRIPTION

13
Documentation/pgm-reindex.txt
View File

@ -4,8 +4,14 @@
reindex - Rebuild the secondary index
== SYNOPSIS
[verse]
--
'java' -jar gerrit.war 'reindex' [<OPTIONS>]
_java_ -jar gerrit.war _reindex_
[--threads]
[--changes-schema-version]
[--verbose]
[--list]
[--index]
--
== DESCRIPTION
@ -15,15 +21,12 @@ Rebuilds the secondary index.
--threads::
Number of threads to use for indexing.
--schema-version::
--changes-schema-version::
Schema version to reindex; default is most recent version.
--verbose::
Output debug information for each change.
--dry-run::
Dry run. Don't write anything to index.
--list::
List available index names.

6
Documentation/pgm-rulec.txt
View File

@ -4,8 +4,12 @@
rulec - Compile project-specific Prolog rules to JARs
== SYNOPSIS
[verse]
--
'java' -jar gerrit.war 'rulec' -d <SITE_PATH> [--all | <PROJECT>...]
_java_ -jar gerrit.war _rulec_
-d <SITE_PATH>
[--quiet]
[--all | <PROJECT>...]
--
== DESCRIPTION