git-review/git-review.1
Catrope fc2e03f7aa Make the default branch configurable
This adds the defaultbranch= option to the config file format, and makes
it the default for the BRANCH command line parameter.

Also removes duplication of the dict with default values

(Amended to pass pep8)

Change-Id: I0fae7ca3a7662fccd491f84a7a3a009480b1c39c
2012-01-24 01:41:38 +01:00

114 lines
2.5 KiB
Groff

.TH "GIT-REVIEW" "1" "October 27, 2011" "2011.10" "git-review"
.SH NAME
git-review \- Submit changes to Gerrit for review
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.\" Man page generated from reStructeredText.
.
.SH SYNOPSIS
.sp
\fBgit\-review\fP [\fIOPTIONS <git\-review\-options\-label\fP] [\fIBRANCH\fP]
.SH DESCRIPTION
.sp
\fBgit\-review\fP automates and streamlines some of the tasks involve with
submitting local changes to a \fIGerrit\fP server for review.
.SH OPTIONS
.INDENT 0.0
.TP
.B \-\-topic, \-t
.sp
Sets the target topic for this change on the gerrit server.
.TP
.B \-\-dry\-run, \-n
.sp
Don\(aqt actually perform any commands that have direct effects. Print them
instead.
.TP
.B \-\-remote, \-r
.sp
git remote to use for gerrit
.TP
.B \-\-no\-rebase, \-R
.sp
Do not automatically perform a rebase before submitting the change to
gerrit.
.TP
.B \-\-download, \-d
.sp
Treat the argument as the review id of a review to download into a local
branch.
.TP
.B \-\-update, \-u
.sp
Skip cached local copies and force updates from network resources.
.TP
.B \-\-setup, \-s
.sp
Just run the repo setup commands but don\(aqt submit anything
.TP
.B \-\-finish, \-f
.sp
Close down the local branch and switch back to the target branch on
successful submission.
.TP
.B \-\-yes, \-y
.sp
Indicate that you do, in fact, understand if you are submitting more than
one patch
.TP
.B \-\-verbose, \-v
.sp
Turns on more verbose output.
.TP
.B \-\-version
.sp
Print the version number and exit.
.UNINDENT
.SH PROJECT CONFIGURATION
.sp
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:
.sp
.nf
.ft C
[gerrit]
host=review.example.com
port=29418
project=project.git
defaultbranch=master
.ft P
.fi
.SH AUTHOR
OpenStack, LLC
.SH COPYRIGHT
2011, OpenStack, LLC
.\" Generated by docutils manpage writer.
.\"
.