NAME¶
git-review —
Submit changes to Gerrit
for review
SYNOPSIS¶
| git-review |
[-r
remote]
[-uv] -d
change
[branch] |
| git-review |
[-r
remote]
[-fnuv] -s
[branch] |
| git-review |
[-fnuvDR]
[-r
remote]
[-t topic]
[branch] |
DESCRIPTION¶
git-review automates and streamlines some of the tasks
involved with submitting local changes to a Gerrit server for review. It is
designed to make it easier to apprehend Gerrit, especially for users that have
recently switched to Git from another version control system.
The following options are available:
- -d
change,
--download=change
- Download change from Gerrit into a
local branch. The branch will be named after the patch author and the name
of a topic. If the local branch already exists, it will attempt to update
with the latest patchset for this change.
- -f,
--finish
- Close down the local branch and switch back to the target
branch on successful submission.
- -n,
--dry-run
- Don't actually perform any commands that have direct
effects. Print them instead.
- -r
remote,
--remote=remote
- Git remote to use for Gerrit.
- -s,
--setup
- Just run the repo setup commands but don't submit
anything.
- -t
topic,
--topic=topic
- Sets the target topic for this change on the gerrit server.
If not specified, a bug number from the commit summary will be used.
Alternatively, the local branch name will be used if different from remote
branch.
- -u,
--update
- Skip cached local copies and force updates from network
resources.
- -l,
--list
- List the available reviews on the gerrit server for this
project.
- -y,
--yes
- Indicate that you do, in fact, understand if you are
submitting more than one patch.
- -v
--verbose
- Turns on more verbose output.
- -D,
--draft
- Submit review as a draft. Requires Gerrit 2.3 or
newer.
- -R,
--no-rebase
- Do not automatically perform a rebase before submitting the
change to Gerrit.
When submitting a change for review, you will usually want it to be based on
the tip of upstream branch in order to avoid possible conflicts. When
amending a change and rebasing the new patchset, the Gerrit web interface
will show a difference between the two patchsets which contains all
commits in between. This may confuse many reviewers that would expect to
see a much simpler difference.
- --version
- Print the version number and exit.
FILES¶
To use
git-review with your project, it is recommended that
you create a file at the root of the repository named
.gitreview and place information about your gerrit
installation in it. The format is similar to the Windows .ini file format:
[gerrit]
host=hostname
port=TCP port number of gerrit
project=project name
defaultbranch=branch to work on
It is also possible to specify optional default name for the Git remote using
the
defaultremote configuration parameter.
Setting
defaultrebase to zero will make
git-review not to rebase changes by default (same as the
-R command line option)
[gerrit]
host=review.example.com
port=29418
project=department/project.git
defaultbranch=master
defaultremote=review
defaultrebase=0
EXAMPLES¶
To fetch a remote change number 3004:
$ git-review -d 3004
Downloading refs/changes/04/3004/1 from gerrit into
review/someone/topic_name
Switched to branch 'review/someone/topic_name
$ git branch
master
* review/author/topic_name
Gerrit looks up both name of the author and the topic name from Gerrit to name a
local branch. This facilitates easier identification of changes.
To send a change for review and delete local branch afterwards:
An example
.gitreview configuration file for a project
department/project hosted on
review.example.com port
29418 in the
branch
master :
[gerrit]
host=review.example.com
port=29418
project=department/project.git
defaultbranch=master
BUGS¶
Bug reports can be submitted to
https://launchpad.net/git-review
AUTHORS¶
git-review is maintained by
OpenStack,
LLC
This manpage has been enhanced by:
Antoine Musso ⟨hashar@free.fr⟩
Marcin Cieslak ⟨saper@saper.info⟩
