summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDavid Pursehouse <david.pursehouse@sonymobile.com>2013-10-23 18:57:22 +0900
committerDavid Pursehouse <david.pursehouse@sonymobile.com>2013-10-23 19:04:10 +0900
commitdf55de62cde5a5dd9a0ffe2fc4fe14373e0d5cb0 (patch)
tree662c059067458b2228e23d2cc403e4a161ff2911
parent121ee23d57c3ca3eca41c743b74c9bec2632e58d (diff)
downloadpygerrit-df55de62cde5a5dd9a0ffe2fc4fe14373e0d5cb0.tar.gz
Document the HTTP password configuration for REST API usage
Change-Id: I2a9d0e50978334e560e076791029746f2531ea51
-rw-r--r--README.rst13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.rst b/README.rst
index 8121db6..0c384fc 100644
--- a/README.rst
+++ b/README.rst
@@ -36,6 +36,18 @@ file:
User username
+For easier connection to the review server over the REST API, the user's
+HTTP username and password can be given in the user's ``.netrc`` file:
+
+.. code-block:: bash
+
+ machine review login MyUsername password MyPassword
+
+
+For instructions on how to obtain the HTTP password, refer to Gerrit's
+`HTTP upload settings`_ documentation.
+
+
SSH Interface
-------------
@@ -116,4 +128,5 @@ license details.
.. _`Gerrit Code Review`: https://code.google.com/p/gerrit/
.. _example: https://github.com/sonyxperiadev/pygerrit/blob/master/example.py
.. _rest_example: https://github.com/sonyxperiadev/pygerrit/blob/master/rest_example.py
+.. _`HTTP upload settings`: http://gerrit-documentation.googlecode.com/svn/Documentation/2.7/user-upload.html#http
.. _LICENSE: https://github.com/sonyxperiadev/pygerrit/blob/master/LICENSE