gerrit/Documentation/cmd-set-reviewers.txt
Luca Milanesio 0995aa7c0e Clarify the behaviour of the project parameter in set-reviewers
Make sure that the role of the project paramter is clear in the SSH
command set-reviewers, so that less people will stuble on it.

Change-Id: If969b6df9e8ee4e660ac16951d62c99b4ce65d26
2019-04-29 13:10:22 +00:00

97 lines
2.4 KiB
Plaintext

= gerrit set-reviewers
== NAME
gerrit set-reviewers - Add or remove reviewers to a change.
== SYNOPSIS
[verse]
--
_ssh_ -p <port> <host> _gerrit set-reviewers_
[--project <PROJECT> | -p <PROJECT>]
[--add <REVIEWER> ... | -a <REVIEWER> ...]
[--remove <REVIEWER> ... | -r <REVIEWER> ...]
[--]
{CHANGE-ID}...
--
== DESCRIPTION
Adds or removes reviewers to the specified change, sending email
notifications when changes are made.
Changes can be specified in the
link:rest-api-changes.html#change-id[same format] supported by the REST
API, as well as with the commit SHA-1 (at least the 7 first characters).
== OPTIONS
--project::
-p::
Name of the project the intended change is contained within. This
option must be supplied before Change-Id in order to take effect.
Please note that the project specified must be active.
If omitted, the impacted changes can be from different projects and
the current user needs to be authorized to set reviewers to all of them.
--add::
-a::
A user that should be added as reviewer to the change or a group
for which all members should be added as reviewers to the change.
Multiple users and groups can be added at once as reviewers by
using this option multiple times.
--remove::
-r::
Remove this user from the reviewer list of the change. Multiple
users can be removed at once from the reviewer list by using this
option multiple times.
--help::
-h::
Display site-specific usage information
== ACCESS
Any user who has SSH access to Gerrit.
== SCRIPTING
This command is intended to be used in scripts.
== EXAMPLES
Add reviewers alice and bob, but remove eve from change Iac6b2ac2.
----
$ ssh -p 29418 review.example.com gerrit set-reviewers \
-a alice@example.com -a bob@example.com \
-r eve@example.com \
Iac6b2ac2
----
Add reviewer elvis to old-style change id 1935 specifying that the change is in project "graceland"
----
$ ssh -p 29418 review.example.com gerrit set-reviewers \
--project graceland \
-a elvis@example.com \
1935
----
Add all project owners as reviewers to change Iac6b2ac2.
----
$ ssh -p 29418 review.example.com gerrit set-reviewers \
-a "'Project Owners'" \
Iac6b2ac2
----
Add all project owners as reviewers to commit 13dff08acca571b22542ebd2e31acf4572ea0b86.
----
$ ssh -p 29418 review.example.com gerrit set-reviewers \
-a "'Project Owners'" \
13dff08acca571b22542ebd2e31acf4572ea0b86
----
GERRIT
------
Part of link:index.html[Gerrit Code Review]
SEARCHBOX
---------