Document gitreview.username

Document git-review specific options
in the Git configuration system.

Currently we have only gitreview.username,
but another one (gitreview.rebase) is
pending in change I96dfab1af48d8f1592766fea4b97e0f35c03d8a5.

Change-Id: I5b34effee355e0075fa3c2c2acea4429198d7e85
This commit is contained in:
Marcin Cieslak 2013-01-31 02:00:40 +01:00
parent 21da8d546c
commit 686f1b0c6b

View File

@ -119,6 +119,25 @@ When submitting a change for review, you will usually want it to be based on the
.It Fl -version
Print the version number and exit.
.El
.Sh CONFIGURATION
This utility can be configured by adding entries to Git configuration.
.Pp
The following configuration keys are supported:
.Bl -tag
.It gitreview.username
Default username used to access the repository. If not specified
in the Git configuration, Git remote or
.Pa .gitreview
file, the user will be prompted to specify the username.
.Pp
Example entry in the
.Pa .gitconfig
file:
.Bd -literal -offset indent
[gitreview]
username=\fImygerrituser\fP
.Ed
.El
.Sh FILES
To use
.Nm