Updated docs to describe setup
Change-Id: Idf7c543c3056b656858ef177e214aaf85b67766e
This commit is contained in:
38
README
38
README
@@ -1,38 +0,0 @@
|
||||
# git-review: A git command for submitting branches to Gerrit
|
||||
|
||||
git-review is a tool that helps submitting git branches to gerrit for review
|
||||
|
||||
# Assumptions
|
||||
|
||||
git-review, by default, looks for a git remote called gerrit, and submits
|
||||
the current branch to HEAD:refs/for/master at that remote.
|
||||
|
||||
# Usage
|
||||
|
||||
Hack on some code, then:
|
||||
|
||||
git review
|
||||
|
||||
If you want to submit that code to a different target branch, then:
|
||||
|
||||
git review branchname
|
||||
|
||||
If you want to submit to a different remote:
|
||||
|
||||
git review -r my-remote
|
||||
|
||||
If you want to supply a review topic:
|
||||
|
||||
git review -t topic/awesome-feature
|
||||
|
||||
If you want to submit your change to a branch other than master:
|
||||
|
||||
git review milestone-proposed
|
||||
|
||||
If you want to skip the automatic rebase -i step:
|
||||
|
||||
git review -R
|
||||
|
||||
If you want to download change 781 from gerrit to review it:
|
||||
|
||||
git review -d 781
|
||||
46
README.md
Normal file
46
README.md
Normal file
@@ -0,0 +1,46 @@
|
||||
# git-review
|
||||
|
||||
A git command for submitting branches to Gerrit
|
||||
|
||||
git-review is a tool that helps submitting git branches to gerrit for review
|
||||
|
||||
## Setup
|
||||
|
||||
git-review, by default, looks for a git remote called gerrit, and submits the current branch to HEAD:refs/for/master at that remote.
|
||||
|
||||
For example, to set it to the OpenStack Compute (nova) project (assuming you have previously signed in to the [OpenStack Gerrit server](https://review.openstack.org) with your Launchpad account), you would do:
|
||||
|
||||
USERNAME=jsmith # Launchpad username here
|
||||
PROJECT=openstack/nova
|
||||
git remote add gerrit ssh://$USERNAME@review.openstack.org:29418/$PROJECT.git
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
Hack on some code, then:
|
||||
|
||||
git review
|
||||
|
||||
If you want to submit that code to a different target branch, then:
|
||||
|
||||
git review branchname
|
||||
|
||||
If you want to submit to a different remote:
|
||||
|
||||
git review -r my-remote
|
||||
|
||||
If you want to supply a review topic:
|
||||
|
||||
git review -t topic/awesome-feature
|
||||
|
||||
If you want to submit your change to a branch other than master:
|
||||
|
||||
git review milestone-proposed
|
||||
|
||||
If you want to skip the automatic rebase -i step:
|
||||
|
||||
git review -R
|
||||
|
||||
If you want to download change 781 from gerrit to review it:
|
||||
|
||||
git review -d 781
|
||||
Reference in New Issue
Block a user