diff options
Diffstat (limited to 'git-codereview/doc.go')
| -rw-r--r-- | git-codereview/doc.go | 11 |
1 files changed, 9 insertions, 2 deletions
diff --git a/git-codereview/doc.go b/git-codereview/doc.go index 012e5ef..ca1b4b2 100644 --- a/git-codereview/doc.go +++ b/git-codereview/doc.go @@ -8,8 +8,9 @@ server. The git-codereview tool manages “change branches” in the local git repository. Each such branch tracks a single commit, or “pending change”, -that is reviewed using a Gerrit server; the Gerrit remote must be -named “origin” in the local git repo. +that is reviewed using a Gerrit server. +The Gerrit remote must be named “origin” in the local git repo, unless +set in configuration under "remote" key. Modifications to the pending change are applied by amending the commit. This process implements the “single-commit feature branch” model. @@ -425,6 +426,12 @@ would typically be “main”, in which case it would have this codereview.cfg: branch: dev.feature parent-branch: main +The "remote" key specifies the name of git remote. +If this setting is missing its default to "origin". +This setting can be useful if you works on fork of the repository. +Your fork can be still the named "origin" and the "upstream" (or other +remote name) can be configured using this key. + In a more complex configuration, one feature branch might depend upon another, like “dev.feature2” containing follow-on work for “dev.feature”, neither of which has merged yet. In this case, the dev.feature2 branch |