cybercyst/go
1
0
Fork 0
mirror of https://github.com/golang/go.git synced 2025-05-05 15:43:04 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

CodeReview: update for Gerrit. first pass.

minux 2014-12-10 23:23:42 -08:00
parent 91e34fec32
commit 3bb258e2c3
1 changed files with 4 additions and 80 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

84
CodeReview.md

@ -17,88 +17,12 @@ There are several terms code reviews may use that you should become familiar wit
# Email
Messages from a code review are typically sent to three places:
* the review itself
* the reviewers, if any
* the golang-codereviews group
* email
* the owner
If you are replying to a review comment through email or the golang-codereviews group, you will notice two extra email addresses - golang-codereviews@googlegroups.com and reply@codereview-hr.appspotmail.com. The former address ensures your message is posted to the golang-codereviews group, and the latter ensures your message is posted back to the review itself. Keeping both of these on your replies makes sure your review message is visible everywhere.
Please do NOT reply code review via email, as the message will not be relayed to Gerrit. Always click on the link and post reply in Gerrit.
# Code Review on Windows
The code review extension depends on Python modules that are not currently included in the standalone Mercurial installer for Windows. Attempting to use the code review extension will result in a "` *** failed to import extension codereview `" error.
## Option 1: Source Installation
To ensure that your Mercurial installation is compatible with the code review plugin, the "source install" package should be used instead of the standalone installer. The process to do this is as follows:
* Check the Mercurial download page to determine the required Python version.
* Install Python using the Windows installer from the Python download page.
* Install Mercurial using the "Mercurial X.XX for Python X.X on Windows (source install)" installer from the Mercurial download page.
* Update your ` PATH ` to include the Python installation directory and its ` scripts ` subdirectory.
## Option 2: Standalone Installation
If you would rather use the standalone Mercurial installer, it is possible to add the missing modules after completing the installation. You will need to copy files from the ` lib ` directory of an existing Python installation to the root directory of the ` library.zip ` file in the Mercurial installation directory. Depending on the version of Mercurial you have installed, the following files/directories may be needed:
* the ` json/ ` subdirectory
* ` htmlentitydefs.py `
* ` HTMLParser.py `
* ` markupbase.py `
# Dealing with Conflicts
When I run ` hg clpatch NNNN `, I get "patch and recent changes conflict". What do I do?
## Option 1: clpatch the old revision, use hg to merge
```
hg clp NNNN
# look at the revision that CL is against; call that revision AAAA
hg up AAAA
hg clp --no_incoming NNNN
hg up
# fix the merge conflicts, if any
# optionally, upload the merged revision:
hg upl NNNN
```
## Option 2: Apply the diff from the codereview website
Visit ` https://codereview.appspot.com/NNNN/ ` and note the raw diff url. It'll likely be something like ` https://codereview.appspot.com/download/issueNNNN_X0001.diff `.
```
# clpatch to bring in the CL metadata
hg clpatch --ignore_hgapplydiff_failure NNNN
# apply the diff
hg import --no-commit --force DIFF_URL
# fix the tree
# optionally, upload the merged revision:
hg upl NNNN
```
# Reverting local changes
You've run ` hg clpatch NNNN `, and you want to restore your repo to a clean state.
```
# Revert file changes.
hg revert @NNNN
# Remove local CL metadata.
hg change -D NNNN
# Remove added files. DANGER: Will delete *all* untracked files.
hg purge
```
# Submitting
If you were just given submit access, congrats. Some tips:
* To check that you do in fact have submit access, go to any issue and click to enter a comment. If you have submit access, you'll notice a lot of extra options available beyond just commenting.
* To submit, you'll need to configure mercurial to authorize with code.google.com. You can do this via the ` .hgrc ` auth section. Sample:
```
[auth]
go.prefix = https://code.google.com/p/go
go.username = *****@****.com
go.password = **********
```
* By default, the password used for code.google.com is **not** your regular Google account password; visit https://code.google.com/hosting/settings.
The code review command ```git-review``` currently does not work on Windows. This is [#9257](../issues/9257).