77c055e618
The description and error messages are outdated and are legacy of the command originally being named "approve". Change them to be more appropriate to the current usage of the command, which is to apply reviews, which may or may not include approvals, to patch sets. Also rename the `approveOne` method to something more appropriate. Change-Id: If95a24b8998bbac9a2ea410ecc05974674070e06
163 lines
4.6 KiB
Plaintext
163 lines
4.6 KiB
Plaintext
gerrit review
|
|
==============
|
|
|
|
== NAME
|
|
gerrit review - Apply reviews to one or more patch sets
|
|
|
|
== SYNOPSIS
|
|
--
|
|
'ssh' -p <port> <host> 'gerrit review'
|
|
[--project <PROJECT> | -p <PROJECT>]
|
|
[--branch <BRANCH> | -b <BRANCH>]
|
|
[--message <MESSAGE> | -m <MESSAGE>]
|
|
[--notify <NOTIFYHANDLING> | -n <NOTIFYHANDLING>]
|
|
[--submit | -s]
|
|
[--abandon | --restore]
|
|
[--publish]
|
|
[--delete]
|
|
[--verified <N>] [--code-review <N>]
|
|
[--label Label-Name=<N>]
|
|
{COMMIT | CHANGEID,PATCHSET}...
|
|
--
|
|
|
|
== DESCRIPTION
|
|
Updates the current user's approval status of the specified patch
|
|
sets and/or submits them for merging, sending out email
|
|
notifications and updating the database.
|
|
|
|
Patch sets may be specified in 'CHANGEID,PATCHSET' format, such as
|
|
'8242,2', or 'COMMIT' format.
|
|
|
|
If a patch set is specified with the 'COMMIT' format, the complete
|
|
or abbreviated commit SHA-1 may be used. If the same commit is available
|
|
in multiple projects the `--project` option may be used to limit where
|
|
Gerrit searches for the change to only the contents of the specified project.
|
|
If the same commit is available in multiple branches the `--branch` option
|
|
may be used to limit where Gerrit searches for changes to only the specified
|
|
branch.
|
|
|
|
|
|
== OPTIONS
|
|
|
|
--project::
|
|
-p::
|
|
Name of the project the intended changes are contained
|
|
within. This option must be supplied before the commit
|
|
SHA-1 in order to take effect.
|
|
|
|
--branch::
|
|
-b::
|
|
Name of the branch the intended changes are contained
|
|
within. This option must be supplied before the commit
|
|
SHA-1 in order to take effect.
|
|
|
|
--message::
|
|
-m::
|
|
Optional cover letter to include as part of the message
|
|
sent to reviewers when the approval states are updated.
|
|
|
|
--notify::
|
|
-n::
|
|
Who to send email notifications to after the review is stored.
|
|
This option only applies for storing the review, but not for any
|
|
other action (abandon, restore etc.) done by this command.
|
|
+
|
|
* NONE: send no email
|
|
* OWNER: send email to change owners
|
|
* OWNER_REVIEWERS: send email to change owners and reviewers
|
|
* ALL: send email to all (change owners, reviewers, watchers and any
|
|
user who has starred the change)
|
|
|
|
--help::
|
|
-h::
|
|
Display site-specific usage information, including the
|
|
complete listing of supported approval categories and values.
|
|
|
|
--abandon::
|
|
Abandon the specified change(s).
|
|
(option is mutually exclusive with --submit and --restore)
|
|
|
|
--restore::
|
|
Restore the specified abandoned change(s).
|
|
(option is mutually exclusive with --abandon)
|
|
|
|
--submit::
|
|
-s::
|
|
Submit the specified patch set(s) for merging.
|
|
(option is mutually exclusive with --abandon)
|
|
|
|
--publish::
|
|
Publish the specified draft patch set(s).
|
|
(option is mutually exclusive with --submit, --restore, --abandon, and --delete)
|
|
|
|
--delete::
|
|
Delete the specified draft patch set(s).
|
|
(option is mutually exclusive with --submit, --restore, --abandon, and --publish)
|
|
|
|
--code-review::
|
|
--verified::
|
|
Set the label to the value 'N'. The exact option names
|
|
supported and the range of values permitted differs per site,
|
|
check the output of --help, or contact your site administrator
|
|
for further details. These options are only available for the
|
|
labels that are defined in the 'All-Projects' root project and
|
|
that are valid for all projects; for other labels, see --label.
|
|
Votes that are not permitted for the user are silently ignored.
|
|
|
|
--label::
|
|
Set a label by name to the value 'N'. Invalid votes (invalid label
|
|
or invalid value) and votes that are not permitted for the user are
|
|
silently ignored.
|
|
|
|
== ACCESS
|
|
Any user who has configured an SSH key.
|
|
|
|
== SCRIPTING
|
|
This command is intended to be used in scripts.
|
|
|
|
== EXAMPLES
|
|
|
|
Approve the change with commit c0ff33 as "Verified +1"
|
|
=====
|
|
$ ssh -p 29418 review.example.com gerrit review --verified +1 c0ff33
|
|
=====
|
|
|
|
Vote on the project specific label "mylabel":
|
|
=====
|
|
$ ssh -p 29418 review.example.com gerrit review --label mylabel=+1 c0ff33
|
|
=====
|
|
|
|
Append the message "Build Successful". Notice two levels of quoting is
|
|
required, one for the local shell, and another for the argument parser
|
|
inside the Gerrit server:
|
|
=====
|
|
$ ssh -p 29418 review.example.com gerrit review -m '"Build Successful"' c0ff33
|
|
=====
|
|
|
|
Mark the unmerged commits both "Verified +1" and "Code-Review +2" and
|
|
submit them for merging:
|
|
====
|
|
$ ssh -p 29418 review.example.com gerrit review \
|
|
--verified +1 \
|
|
--code-review +2 \
|
|
--submit \
|
|
--project this/project \
|
|
$(git rev-list origin/master..HEAD)
|
|
====
|
|
|
|
Abandon an active change:
|
|
====
|
|
$ ssh -p 29418 review.example.com gerrit review --abandon c0ff33
|
|
====
|
|
|
|
== SEE ALSO
|
|
|
|
* link:access-control.html[Access Controls]
|
|
|
|
GERRIT
|
|
------
|
|
Part of link:index.html[Gerrit Code Review]
|
|
|
|
SEARCHBOX
|
|
---------
|