From 686f1b0c6bac1f41c77c7663f08529d42c41921a Mon Sep 17 00:00:00 2001
From: Marcin Cieslak <saper@saper.info>
Date: Thu, 31 Jan 2013 02:00:40 +0100
Subject: 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
---
 git-review.1 | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

(limited to 'git-review.1')

diff --git a/git-review.1 b/git-review.1
index 94eea63..26c2cf4 100644
--- a/git-review.1
+++ b/git-review.1
@@ -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
-- 
cgit v1.2.1