opendev/git-restack
Code Issues Proposed changes

Document defaultremote option & site/user configs

Browse Source 
This change documents the 'defaultremote' configuration option and the ability
to specify default values using a user or site configuration file.

Change-Id: I045ade9ff699b38977c5974b7185081552cd08e8
This commit is contained in:
Ori Livneh
2013-05-28 11:15:18 -07:00
parent 267b8a8e4d
commit 3574a6d893
1 changed files with 19 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
README.rst
View File

@@ -9,15 +9,19 @@ review.
Setup Setup
----- -----
git-review, by default, looks for a git remote called gerrit, and By default, git-review will look for a remote named 'gerrit' for working
submits the current branch to HEAD:refs/for/master at that remote. with Gerrit. If the remote exists, git-review will submit the current
branch to HEAD:refs/for/master at that remote.
If the "gerrit" remote does not exist, git-review looks for a file If the Gerrit remote does not exist, git-review looks for a file
called .gitreview at the root of the repository with information about called .gitreview at the root of the repository with information about
the gerrit remote. Assuming that file is present, git-review should the gerrit remote. Assuming that file is present, git-review should
be able to automatically configure your repository the first time it be able to automatically configure your repository the first time it
is run. is run.
The name of the Gerrit remote is configurable; see the configuration
section below.
Usage Usage
----- -----
@@ -74,15 +78,23 @@ Example .gitreview file (used to upload for git-review itself)::
Required values: host, project Required values: host, project
Optional values: port (default: 29418), defaultbranch (default: master) Optional values: port (default: 29418), defaultbranch (default: master),
defaultremote (default: gerrit).
**Notes** **Notes**
* Username not required because it is requested on first run * Username is not required because it is requested on first run
* Unlike git config files there cannot be any whitespace before the name of the variable. * Unlike git config files, there cannot be any whitespace before the name
of the variable.
* git-review will create a gerrit remote upon first run * Upon first run, git-review will create a remote for working with Gerrit,
if it does not already exist. By default, the remote name is 'gerrit',
but this can be overridden with the 'defaultremote' configuration
option.
* You can specify different values to be used as defaults in
~/.config/git-review/git-review.conf or /etc/git-review/git-review.conf.
Hooks Hooks
----- -----