Clear up syntax for command reference files
Change-Id: I687a0efcb603912a96406876f8f987512d46e449
This commit is contained in:
David Shevitz
parent
51cb2ea2ff
commit
e369eeee95
@ -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
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
= kill
|
||||
|
||||
== NAME
|
||||
kill - Cancel or abort a background task
|
||||
kill - Cancel or abort a background task.
|
||||
|
||||
== SYNOPSIS
|
||||
[verse]
|
||||
|
||||
@ -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
|
||||
|
||||
@ -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
|
||||
|
||||
@ -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
|
||||
|
||||
@ -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
|
||||
|
||||
@ -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
|
||||
$ 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/
|
||||
platform/manifest
|
||||
tools/gerrit
|
||||
tools/gwtorm
|
||||
|
||||
$ curl http://review.example.com/projects/tools/
|
||||
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
|
||||
|
||||
@ -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
|
||||
|
||||
@ -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
|
||||
|
||||
Loading…
Reference in New Issue
Block a user