diff --git a/README.md b/README.md index d88f6f9..074c8ff 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,13 @@ -# git-review +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 +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. @@ -16,42 +18,45 @@ the gerrit remote. Assuming that file is present, git-review should be able to automatically configure your repository the first time it is run. -## Usage +Usage +----- -Hack on some code, then: +Hack on some code, then:: git review -If you want to submit that code to a branch other than "master", then: +If you want to submit that code to a branch other than "master", then:: git review branchname -If you want to submit to a different remote: +If you want to submit to a different remote:: git review -r my-remote -If you want to supply a review topic: +If you want to supply a review topic:: git review -t topic/awesome-feature -If you want to submit a branch for review and then remove the local branch: +If you want to submit a branch for review and then remove the local branch:: git review -f -If you want to skip the automatic "git rebase -i" step: +If you want to skip the automatic "git rebase -i" step:: git review -R -If you want to download change 781 from gerrit to review it: +If you want to download change 781 from gerrit to review it:: git review -d 781 -If you just want to do the commit message and remote setup steps: +If you just want to do the commit message and remote setup steps:: git review -s -## .gitreview file format -Example .gitreview file (used to upload for git-review itself) +.gitreview file format +---------------------- + +Example .gitreview file (used to upload for git-review itself):: [gerrit] host=review.openstack.org @@ -63,17 +68,23 @@ Required values: host, project Optional values: port (default: 29418), defaultbranch (default: master) -### Notes +**Notes** + * Username not required because it is requested on first run + * Unlike git config files there cannot be any whitespace before the name of the variable. + * git-review will create a gerrit remote upon first run -## Installation +Installation +------------ + Install with pip install git-review For installation from source simply add git-review to your $PATH -## Contributing +Contributing +------------ To get the latest code, see: https://github.com/openstack-infra/git-review @@ -83,7 +94,7 @@ There is a mailing list at: http://lists.openstack.org/cgi-bin/mailman/listinfo/ Code reviews, as you might expect, are handled by gerrit at: https://review.openstack.org -Use `git review` to submit patches (after creating a gerrit account that links to your launchpad account). Example: +Use ``git review`` to submit patches (after creating a gerrit account that links to your launchpad account). Example:: # Do your commits git review