b8b908af1f
Move manual gerrit remote setup docs from README to man page (that's advanced usage). Remove rendundant documentation from the README. Add --version option. Add documentation on contributing. Change-Id: I624b56a629a6120e91ef1bfa0f4bb801b60b9d5d
2.1 KiB
git-review
SYNOPSIS
git-review
[OPTIONS <git-review-options-label]
[BRANCH]
DESCRIPTION
git-review
automates and streamlines some of the tasks involve with submitting
local changes to a Gerrit server for review.
OPTIONS
git-review
--topic, -t
Sets the target topic for this change on the gerrit server.
--dry-run, -n
Don't actually perform any commands that have direct effects. Print them instead.
--no-rebase, -R
Do not automatically perform a rebase before submitting the change to gerrit.
--update, -R
Skip cached local copies and force updates from network resources.
--download, -d
Download a change from gerrit into a branch for review. Takes a numeric change id as an argument.
--setup, -s
Just run through the repo setup commands and then exit before attempting to submit anything.
--verbose, -v
Turns on more verbose output.
--help, -h
Print usage information and exit.
--version
Print version information and exit.
PROJECT CONFIGURATION
To use git-review with your project, it is recommended that you create a file at the root of the repository called ".gitreview" and place information about your gerrit installation in it. The format is:
[gerrit]
host=review.example.com
port=29418
project=project.gitMANUAL CONFIGURATION
If there is no existing remote named "gerrit", and no ".gitreview" file in the current repository, you may need to manually create a git remote called "gerrit". To do so, execute a command like:
USERNAME=jsmith
PROJECT=foobar
git remote add gerrit ssh://$USERNAME@review.example.com:29418/$PROJECT.gitSet USERNAME to your gerrit username, and PROJECT to the project name in gerrit.