From 722f7d280b8c6829fbacd049c339b9c0edf75f12 Mon Sep 17 00:00:00 2001 From: Andrew Gerrand Date: Thu, 18 Dec 2014 11:42:25 +1100 Subject: [PATCH] doc: use 'git-codereview' in contributor docs Change-Id: I63d5c81fdaf9aca2fc3da3defcc6e9c4094c690b Reviewed-on: https://go-review.googlesource.com/1742 Reviewed-by: Andrew Gerrand --- doc/contribute.html | 47 +++++++++++++++++++++++---------------------- 1 file changed, 24 insertions(+), 23 deletions(-) diff --git a/doc/contribute.html b/doc/contribute.html index ba550d5281..6a20816345 100644 --- a/doc/contribute.html +++ b/doc/contribute.html @@ -77,7 +77,7 @@ Changes to Go must be reviewed before they are submitted, no matter who makes the change. (In exceptional cases, such as fixing a build, the review can follow shortly after submitting.) -A custom git command called git-review, +A custom git command called git-codereview, discussed below, helps manage the code review process through a Google-hosted instance of the code review system called Gerrit. @@ -132,44 +132,44 @@ and log in using the same Google Account you used above. That is all that is required.

-

Install the git-review command

+

Install the git-codereview command

-Now install the git-review command by running, +Now install the git-codereview command by running, 

-go get -u golang.org/x/review/git-review
+go get -u golang.org/x/review/git-codereview

-Make sure git-review is installed in your shell path, so that the +Make sure git-codereview is installed in your shell path, so that the git command can find it. Check that 

 $ git review help
- +

prints help text, not an error.

-Note to Git aficionados: The git-review command is not required to +Note to Git aficionados: The git-codereview command is not required to upload and manage Gerrit code reviews. For those who prefer plain Git, the text -below gives the Git equivalent of each git-review command. If you do use plain -Git, note that you still need the commit hooks that the git-review command +below gives the Git equivalent of each git-codereview command. If you do use plain +Git, note that you still need the commit hooks that the git-codereview command configures; those hooks add a Gerrit Change-Id line to the commit message and check that all Go source files have been formatted with gofmt. Even if you intend to use plain Git for daily work, install the hooks in a new Git -checkout by running git-review hooks). +checkout by running git-codereview hooks).

Set up git aliases

-The git-review command can be run directly from the shell +The git-codereview command can be run directly from the shell by typing, for instance,

@@ -178,7 +178,7 @@ $ git review sync

-but it is more convenient to set up aliases for git-review's own +but it is more convenient to set up aliases for git-codereview's own subcommands, so that the above becomes,

@@ -186,8 +186,8 @@ subcommands, so that the above becomes, $ git sync -

-The git-review subcommands have been chosen to be distinct from +

+The git-codereview subcommands have been chosen to be distinct from Git's own, so it's safe to do so.

@@ -200,16 +200,17 @@ To install them, copy this text into your Git configuration file 
 [alias]
-	change = review change
-	gofmt = review gofmt
-	mail = review mail
-	pending = review pending
-	sync = review sync
+	change = codereview change
+	gofmt = codereview gofmt
+	mail = codereview mail
+	pending = codereview pending
+	submit = codereview submit
+	sync = codereview sync
-

Understanding the git-review command

+

Understanding the git-codereview command

-

After installing the git-review command, you can run

+

After installing the git-codereview command, you can run

 $ git review help
@@ -217,7 +218,7 @@ $ git review help
 
 

 to learn more about its commands.
-You can also read the command documentation.
+You can also read the command documentation.
 

 
 
Switch to the master branch

@@ -367,7 +368,7 @@ Do not edit or delete it.
 

 (In Git terms, git change with no branch name
 runs git commit --amend.)
-
 
+

 
 
Mail the change for review

 
-- 
2.50.0