summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/index.rst11
1 files changed, 11 insertions, 0 deletions
diff --git a/doc/index.rst b/doc/index.rst
index a7795d5..5ab13fa 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -57,3 +57,14 @@ OPTIONS
Turns on more verbose output.
+PROJECT CONFIGURATION
+---------------------
+
+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::
+
+ [gerrit]
+ host=review.example.com
+ port=29418
+ project=project.git