From a843461b18733d39f71d08d5f92d85512b56f675 Mon Sep 17 00:00:00 2001 From: Michael Ochmann Date: Fri, 8 Jul 2016 10:58:27 +0200 Subject: [PATCH] Some more broken synopsis formattings in documentation Same exercise as in change 79311 but now for the pgm commands. Fixed some syntax expressions that did not match the list of command options and harmonized the indentation. Change-Id: Ieec06ea87ecbc8cda467f58d514e2f29993ba46e Signed-off-by: Michael Ochmann --- Documentation/dev-inspector.txt | 15 +++++------ .../pgm-LocalUsernamesToLowerCase.txt | 5 +++- Documentation/pgm-SwitchSecureStore.txt | 4 ++- Documentation/pgm-daemon.txt | 19 +++++++------- Documentation/pgm-gsql.txt | 4 ++- Documentation/pgm-init.txt | 25 ++++++++++--------- Documentation/pgm-prolog-shell.txt | 4 ++- Documentation/pgm-reindex.txt | 13 ++++++---- Documentation/pgm-rulec.txt | 6 ++++- 9 files changed, 57 insertions(+), 38 deletions(-) diff --git a/Documentation/dev-inspector.txt b/Documentation/dev-inspector.txt index 7c13a7defd..5e02bf7443 100644 --- a/Documentation/dev-inspector.txt +++ b/Documentation/dev-inspector.txt @@ -4,14 +4,15 @@ Gerrit Inspector - Interactive Jython environment for Gerrit == SYNOPSIS +[verse] -- -'java' -jar gerrit.war 'daemon' - -d - [\--enable-httpd | \--disable-httpd] - [\--enable-sshd | \--disable-sshd] - [\--console-log] - [\--slave] - -s +_java_ -jar gerrit.war _daemon_ + -d + [--enable-httpd | --disable-httpd] + [--enable-sshd | --disable-sshd] + [--console-log] + [--slave] + -s -- == DESCRIPTION diff --git a/Documentation/pgm-LocalUsernamesToLowerCase.txt b/Documentation/pgm-LocalUsernamesToLowerCase.txt index 72dded6485..1136ced619 100644 --- a/Documentation/pgm-LocalUsernamesToLowerCase.txt +++ b/Documentation/pgm-LocalUsernamesToLowerCase.txt @@ -5,8 +5,11 @@ LocalUsernamesToLowerCase - Convert the local username of every account to lower case == SYNOPSIS +[verse] -- -'java' -jar gerrit.war 'LocalUsernamesToLowerCase' -d +_java_ -jar gerrit.war _LocalUsernamesToLowerCase + -d + [--threads] -- == DESCRIPTION diff --git a/Documentation/pgm-SwitchSecureStore.txt b/Documentation/pgm-SwitchSecureStore.txt index f9b2aa4dfb..47de1bed38 100644 --- a/Documentation/pgm-SwitchSecureStore.txt +++ b/Documentation/pgm-SwitchSecureStore.txt @@ -4,8 +4,10 @@ SwitchSecureStore - Changes the currently used SecureStore implementation == SYNOPSIS +[verse] -- -'java' -jar gerrit.war 'SwitchSecureStore' [] +_java_ -jar gerrit.war _SwitchSecureStore_ + [--new-secure-store-lib] -- == DESCRIPTION diff --git a/Documentation/pgm-daemon.txt b/Documentation/pgm-daemon.txt index bcf2b1b722..76a26e1916 100644 --- a/Documentation/pgm-daemon.txt +++ b/Documentation/pgm-daemon.txt @@ -4,16 +4,17 @@ daemon - Gerrit network server == SYNOPSIS +[verse] -- -'java' -jar gerrit.war 'daemon' - -d - [--enable-httpd | --disable-httpd] - [--enable-sshd | --disable-sshd] - [--console-log] - [--slave] - [--headless] - [--init] - [-s] +_java_ -jar gerrit.war _daemon_ + -d + [--enable-httpd | --disable-httpd] + [--enable-sshd | --disable-sshd] + [--console-log] + [--slave] + [--headless] + [--init] + [-s] -- == DESCRIPTION diff --git a/Documentation/pgm-gsql.txt b/Documentation/pgm-gsql.txt index b4ccf84a61..4986522191 100644 --- a/Documentation/pgm-gsql.txt +++ b/Documentation/pgm-gsql.txt @@ -4,8 +4,10 @@ gsql - Administrative interface to idle database == SYNOPSIS +[verse] -- -'java' -jar gerrit.war 'gsql' -d +_java_ -jar gerrit.war _gsql_ + -d -- == DESCRIPTION diff --git a/Documentation/pgm-init.txt b/Documentation/pgm-init.txt index 22f9109e83..40c2b300a6 100644 --- a/Documentation/pgm-init.txt +++ b/Documentation/pgm-init.txt @@ -4,19 +4,20 @@ init - Initialize/Upgrade a Gerrit server installation == SYNOPSIS +[verse] -- -'java' -jar gerrit.war 'init' - -d - [--batch] - [--no-auto-start] - [--skip-plugins] - [--list-plugins] - [--install-plugin=] - [--install-all-plugins] - [--secure-store-lib] - [--dev] - [--skip-all-downloads] - [--skip-download=] +_java_ -jar gerrit.war _init_ + -d + [--batch] + [--no-auto-start] + [--skip-plugins] + [--list-plugins] + [--install-plugin=] + [--install-all-plugins] + [--secure-store-lib] + [--dev] + [--skip-all-downloads] + [--skip-download=] -- == DESCRIPTION diff --git a/Documentation/pgm-prolog-shell.txt b/Documentation/pgm-prolog-shell.txt index ede37241d5..aee5799757 100644 --- a/Documentation/pgm-prolog-shell.txt +++ b/Documentation/pgm-prolog-shell.txt @@ -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 diff --git a/Documentation/pgm-reindex.txt b/Documentation/pgm-reindex.txt index f0818430c8..e13d518fc0 100644 --- a/Documentation/pgm-reindex.txt +++ b/Documentation/pgm-reindex.txt @@ -4,8 +4,14 @@ reindex - Rebuild the secondary index == SYNOPSIS +[verse] -- -'java' -jar gerrit.war 'reindex' [] +_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. diff --git a/Documentation/pgm-rulec.txt b/Documentation/pgm-rulec.txt index 05c7d251cb..1b50812aaa 100644 --- a/Documentation/pgm-rulec.txt +++ b/Documentation/pgm-rulec.txt @@ -4,8 +4,12 @@ rulec - Compile project-specific Prolog rules to JARs == SYNOPSIS +[verse] -- -'java' -jar gerrit.war 'rulec' -d [--all | ...] +_java_ -jar gerrit.war _rulec_ + -d + [--quiet] + [--all | ...] -- == DESCRIPTION