1b20aa2df3
If we upload source tarballs to PyPI instead of eggs, then the man pages actually work. However, this means that the installer has to run setup.py. Using sphinx, while slighly nicer from a dev perspective, means we have to then require that people installing git-review also install sphinx, which is a bit overkill given the size of the man page. This change, and a change to the release process of not uploading eggs to PyPI should finall get git review --help to work. Change-Id: I29b07667127a9ec5c241b7e1fc5a3960dd2a6b63
94 lines
2.0 KiB
Groff
94 lines
2.0 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.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-dry\-run, \-n
|
|
.sp
|
|
Don\(aqt actually perform any commands that have direct effects. Print them
|
|
instead.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-no\-rebase, \-R
|
|
.sp
|
|
Do not automatically perform a rebase before submitting the change to
|
|
gerrit.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-update, \-R
|
|
.sp
|
|
Skip cached local copies and force updates from network resources.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-\-verbose, \-v
|
|
.sp
|
|
Turns on more verbose output.
|
|
.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
|
|
.ft P
|
|
.fi
|
|
.SH AUTHOR
|
|
OpenStack, LLC
|
|
.SH COPYRIGHT
|
|
2011, OpenStack, LLC
|
|
.\" Generated by docutils manpage writer.
|
|
.\"
|
|
.
|