aboutsummaryrefslogtreecommitdiff
path: root/git-codereview/doc.go
diff options
context:
space:
mode:
authorMarvin Stenger <marvin.stenger94@gmail.com>2018-04-04 12:34:26 +0200
committerBrad Fitzpatrick <bradfitz@golang.org>2018-04-04 16:07:47 +0000
commit8545223bc1b05b842f3f3a11e66cd902bf046efe (patch)
treead992cb6ae3172eaccf3cb36eb83eec298fac0cb /git-codereview/doc.go
parentfebe82b3542e335479ef0e8a401a0e95f070fa41 (diff)
downloadgo-x-review-8545223bc1b05b842f3f3a11e66cd902bf046efe.tar.xz
git-codereview: pull punctuation marks out of quotation marks
Command-line commands listed in the documentation are put in quotation marks. In some places punctuation marks were also placed between the quotation marks, which could suggest that they are part of the command. So we pull those punctuation marks out. Change-Id: I7057747a0f045394976f04f8be387e18805c22e1 Reviewed-on: https://go-review.googlesource.com/104657 Reviewed-by: Daniel Martí <mvdan@mvdan.cc> Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
Diffstat (limited to 'git-codereview/doc.go')
-rw-r--r--git-codereview/doc.go12
1 files changed, 6 insertions, 6 deletions
diff --git a/git-codereview/doc.go b/git-codereview/doc.go
index 890cb9d..443ae55 100644
--- a/git-codereview/doc.go
+++ b/git-codereview/doc.go
@@ -7,7 +7,7 @@ Git-codereview manages the code review process for Git changes using a Gerrit
server.
The git-codereview tool manages ``change branches'' in the local git repository.
-Each such branch tracks a single commit, or ``pending change,''
+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.
@@ -47,9 +47,9 @@ either no pending change beyond origin/master (when there's no local work)
or exactly one pending change beyond origin/master (the change being developed).
When there is no pending change on the work branch,
-``git codereview change'' creates one by running ``git commit.''
+``git codereview change'' creates one by running ``git commit''.
Otherwise, when there is already a pending change,
-``git codereview change'' revises it by running ``git commit --amend.''
+``git codereview change'' revises it by running ``git commit --amend''.
The ``git codereview mail'' and ``git codereview submit'' commands
implicitly operate on the lone pending change.
@@ -67,10 +67,10 @@ multiple pending changes.
The ``git codereview change'' command amends the top commit in the stack (HEAD).
To amend a commit further down the stack, use Git's rebase support,
-for example by using ``git commit --fixup'' followed by ``git codereview rebase-work.''
+for example by using ``git commit --fixup'' followed by ``git codereview rebase-work''.
The ``git codereview mail'' command requires an explicit revision argument,
-but note that since ``git codereview mail'' is implemented as a ``git push,''
+but note that since ``git codereview mail'' is implemented as a ``git push'',
any commits earlier in the stack are necessarily also mailed.
The ``git codereview submit'' command also requires an explicit revision argument,
@@ -81,7 +81,7 @@ effectively runs ``git codereview sync'' automatically.
In a multiple-commit work branch, it does not, because
the implied ``git rebase'' may conflict with the remaining pending commits.
Instead it is necessary to run ``git codereview sync'' explicitly
-(when ready) after ``git codereview submit.''
+(when ready) after ``git codereview submit''.
Reusing Work Branches