diff options
author | David Shevitz <dshevitz@google.com> | 2018-09-26 12:31:46 -0700 |
---|---|---|
committer | David Shevitz <dshevitz@google.com> | 2018-09-26 12:31:46 -0700 |
commit | e369eeee95db462cb37db321b551eb9806ffbcdf (patch) | |
tree | 12619573af823370cd8d977b4aeda7b046a706a3 | |
parent | 51cb2ea2ff2f78105bcc9b633b7526535083578b (diff) |
Clear up syntax for command reference files
Change-Id: I687a0efcb603912a96406876f8f987512d46e449
-rw-r--r-- | Documentation/cmd-index-start.txt | 4 | ||||
-rw-r--r-- | Documentation/cmd-kill.txt | 2 | ||||
-rw-r--r-- | Documentation/cmd-logging-ls-level.txt | 9 | ||||
-rw-r--r-- | Documentation/cmd-logging-set-level.txt | 10 | ||||
-rw-r--r-- | Documentation/cmd-ls-groups.txt | 44 | ||||
-rw-r--r-- | Documentation/cmd-ls-members.txt | 16 | ||||
-rw-r--r-- | Documentation/cmd-ls-projects.txt | 38 | ||||
-rw-r--r-- | Documentation/cmd-ls-user-refs.txt | 4 | ||||
-rw-r--r-- | Documentation/cmd-plugin-enable.txt | 2 |
9 files changed, 63 insertions, 66 deletions
diff --git a/Documentation/cmd-index-start.txt b/Documentation/cmd-index-start.txt index 5a002f397d..d1a02b362f 100644 --- a/Documentation/cmd-index-start.txt +++ b/Documentation/cmd-index-start.txt @@ -1,7 +1,7 @@ = gerrit index start == NAME -gerrit index start - Start the online indexer +gerrit index start - Start the online indexer. == SYNOPSIS [verse] @@ -44,7 +44,7 @@ This command is intended to be used in scripts. Start the online indexer for the 'changes' index: ---- - $ ssh -p 29418 review.example.com gerrit index start changes +$ ssh -p 29418 review.example.com gerrit index start changes ---- GERRIT diff --git a/Documentation/cmd-kill.txt b/Documentation/cmd-kill.txt index ac8e8028a3..db5093d221 100644 --- a/Documentation/cmd-kill.txt +++ b/Documentation/cmd-kill.txt @@ -1,7 +1,7 @@ = kill == NAME -kill - Cancel or abort a background task +kill - Cancel or abort a background task. == SYNOPSIS [verse] diff --git a/Documentation/cmd-logging-ls-level.txt b/Documentation/cmd-logging-ls-level.txt index ee015bb0de..fb1fb33efd 100644 --- a/Documentation/cmd-logging-ls-level.txt +++ b/Documentation/cmd-logging-ls-level.txt @@ -1,9 +1,9 @@ = gerrit logging ls-level == NAME -gerrit logging ls-level - view the logging level +gerrit logging ls-level - view the logging level. -gerrit logging ls - view the logging level +gerrit logging ls - view the logging level. == SYNOPSIS [verse] @@ -27,13 +27,12 @@ Caller must have the ADMINISTRATE_SERVER capability. View the logging level of the loggers in the package com.google: ---- - $ssh -p 29418 review.example.com gerrit logging ls-level \ - com.google. +$ssh -p 29418 review.example.com gerrit logging ls-level com.google. ---- View the logging level of every logger ---- - $ssh -p 29418 review.example.com gerrit logging ls-level +$ssh -p 29418 review.example.com gerrit logging ls-level ---- GERRIT diff --git a/Documentation/cmd-logging-set-level.txt b/Documentation/cmd-logging-set-level.txt index 5baa9687c4..d7fc69e1bc 100644 --- a/Documentation/cmd-logging-set-level.txt +++ b/Documentation/cmd-logging-set-level.txt @@ -1,9 +1,9 @@ = gerrit logging set-level == NAME -gerrit logging set-level - set the logging level +gerrit logging set-level - set the logging level. -gerrit logging set - set the logging level +gerrit logging set - set the logging level. == SYNOPSIS [verse] @@ -34,14 +34,12 @@ Caller must have the ADMINISTRATE_SERVER capability. Change the logging level of the loggers in the package com.google to DEBUG. ---- - $ssh -p 29418 review.example.com gerrit logging set-level \ - debug com.google. +$ssh -p 29418 review.example.com gerrit logging set-level debug com.google. ---- Reset the logging level of every logger to what they were at deployment time. ---- - $ssh -p 29418 review.example.com gerrit logging set-level \ - reset +$ssh -p 29418 review.example.com gerrit logging set-level reset ---- GERRIT diff --git a/Documentation/cmd-ls-groups.txt b/Documentation/cmd-ls-groups.txt index 6d4bdc5374..8a4845c263 100644 --- a/Documentation/cmd-ls-groups.txt +++ b/Documentation/cmd-ls-groups.txt @@ -1,7 +1,7 @@ = gerrit ls-groups == NAME -gerrit ls-groups - List groups visible to caller +gerrit ls-groups - List groups visible to caller. == SYNOPSIS [verse] @@ -88,53 +88,53 @@ nonexistent group, the owner group name field will read `n/a`. List visible groups: ---- - $ ssh -p 29418 review.example.com gerrit ls-groups - Administrators - Anonymous Users - MyProject_Committers - Project Owners - Registered Users +$ ssh -p 29418 review.example.com gerrit ls-groups +Administrators +Anonymous Users +MyProject_Committers +Project Owners +Registered Users ---- List all groups for which any permission is set for the project "MyProject": ---- - $ ssh -p 29418 review.example.com gerrit ls-groups --project MyProject - MyProject_Committers - Project Owners - Registered Users +$ ssh -p 29418 review.example.com gerrit ls-groups --project MyProject +MyProject_Committers +Project Owners +Registered Users ---- List all groups which are owned by the calling user: ---- - $ ssh -p 29418 review.example.com gerrit ls-groups --owned - MyProject_Committers - MyProject_Verifiers +$ ssh -p 29418 review.example.com gerrit ls-groups --owned +MyProject_Committers +MyProject_Verifiers ---- Check if the calling user owns the group `MyProject_Committers`. If `MyProject_Committers` is returned the calling user owns this group. If the result is empty, the calling user doesn't own the group. ---- - $ ssh -p 29418 review.example.com gerrit ls-groups --owned -q MyProject_Committers - MyProject_Committers +$ ssh -p 29418 review.example.com gerrit ls-groups --owned -q MyProject_Committers +MyProject_Committers ---- Extract the UUID of the 'Administrators' group: ---- - $ ssh -p 29418 review.example.com gerrit ls-groups -v | awk '-F\t' '$1 == "Administrators" {print $2}' - ad463411db3eec4e1efb0d73f55183c1db2fd82a +$ ssh -p 29418 review.example.com gerrit ls-groups -v | awk '-F\t' '$1 == "Administrators" {print $2}' +ad463411db3eec4e1efb0d73f55183c1db2fd82a ---- Extract and expand the multi-line description of the 'Administrators' group: ---- - $ printf "$(ssh -p 29418 review.example.com gerrit ls-groups -v | awk '-F\t' '$1 == "Administrators" {print $3}')\n" - This is a - multi-line - description. +$ printf "$(ssh -p 29418 review.example.com gerrit ls-groups -v | awk '-F\t' '$1 == "Administrators" {print $3}')\n" +This is a +multi-line +description. ---- GERRIT diff --git a/Documentation/cmd-ls-members.txt b/Documentation/cmd-ls-members.txt index 273451ba04..8f8857c5bb 100644 --- a/Documentation/cmd-ls-members.txt +++ b/Documentation/cmd-ls-members.txt @@ -1,7 +1,7 @@ = gerrit ls-members == NAME -gerrit ls-members - Show members of a given group +gerrit ls-members - Show members of a given group. == SYNOPSIS [verse] @@ -40,17 +40,17 @@ the output. List members of the Administrators group: ---- - $ ssh -p 29418 review.example.com gerrit ls-members Administrators - id username full name email - 100000 jim Jim Bob somebody@example.com - 100001 johnny John Smith n/a - 100002 mrnoname n/a someoneelse@example.com +$ ssh -p 29418 review.example.com gerrit ls-members Administrators +id username full name email +100000 jim Jim Bob somebody@example.com +100001 johnny John Smith n/a +100002 mrnoname n/a someoneelse@example.com ---- List members of a non-existent group: ---- - $ ssh -p 29418 review.example.com gerrit ls-members BadlySpelledGroup - Group not found or not visible +$ ssh -p 29418 review.example.com gerrit ls-members BadlySpelledGroup +Group not found or not visible ---- GERRIT diff --git a/Documentation/cmd-ls-projects.txt b/Documentation/cmd-ls-projects.txt index 486ca44aab..3bb8e4f597 100644 --- a/Documentation/cmd-ls-projects.txt +++ b/Documentation/cmd-ls-projects.txt @@ -1,7 +1,7 @@ = gerrit ls-projects == NAME -gerrit ls-projects - List projects visible to caller +gerrit ls-projects - List projects visible to caller. == SYNOPSIS [verse] @@ -115,28 +115,28 @@ by the client in the request headers. List visible projects: ---- - $ ssh -p 29418 review.example.com gerrit ls-projects - platform/manifest - tools/gerrit - tools/gwtorm - - $ curl http://review.example.com/projects/ - platform/manifest - tools/gerrit - tools/gwtorm - - $ curl http://review.example.com/projects/tools/ - tools/gerrit - tools/gwtorm +$ ssh -p 29418 review.example.com gerrit ls-projects +platform/manifest +tools/gerrit +tools/gwtorm + +$ curl http://review.example.com/projects/ +platform/manifest +tools/gerrit +tools/gwtorm + +$ curl http://review.example.com/projects/tools/ +tools/gerrit +tools/gwtorm ---- Clone any project visible to the user: ---- - for p in `ssh -p 29418 review.example.com gerrit ls-projects` - do - mkdir -p `dirname "$p"` - git clone --bare "ssh://review.example.com:29418/$p.git" "$p.git" - done +for p in `ssh -p 29418 review.example.com gerrit ls-projects` +do + mkdir -p `dirname "$p"` + git clone --bare "ssh://review.example.com:29418/$p.git" "$p.git" +done ---- == SEE ALSO diff --git a/Documentation/cmd-ls-user-refs.txt b/Documentation/cmd-ls-user-refs.txt index 1a87fc9507..cba7d1bdef 100644 --- a/Documentation/cmd-ls-user-refs.txt +++ b/Documentation/cmd-ls-user-refs.txt @@ -1,7 +1,7 @@ = gerrit ls-user-refs == NAME -gerrit ls-user-refs - List refs visible to a specific user +gerrit ls-user-refs - List refs visible to a specific user. == SYNOPSIS [verse] @@ -42,7 +42,7 @@ Administrators List visible refs for the user "mr.developer" in project "gerrit" ---- - $ ssh -p 29418 review.example.com gerrit ls-user-refs -p gerrit -u mr.developer +$ ssh -p 29418 review.example.com gerrit ls-user-refs -p gerrit -u mr.developer ---- GERRIT diff --git a/Documentation/cmd-plugin-enable.txt b/Documentation/cmd-plugin-enable.txt index 9b5273630c..955267e88c 100644 --- a/Documentation/cmd-plugin-enable.txt +++ b/Documentation/cmd-plugin-enable.txt @@ -32,7 +32,7 @@ This command is intended to be used in scripts. Enable a plugin: ---- - ssh -p 29418 localhost gerrit plugin enable my-plugin +ssh -p 29418 localhost gerrit plugin enable my-plugin ---- GERRIT |