| Russ Cox | 0e9f396 | 2009-08-08 13:38:40 -0700 | [diff] [blame] | 1 | .TH CODEREVIEW 1 |
| 2 | .SH NAME |
| 3 | codereview \- review of submitted changes (experimental) |
| 4 | .SH SYNOPSIS |
| 5 | .B hg |
| 6 | .B diff |
| 7 | .I path ... |
| 8 | .PP |
| 9 | .B codereview |
| 10 | .I path ... |
| 11 | .PP |
| 12 | .B codereview |
| 13 | .B -i |
| 14 | .I issue |
| 15 | .I path ... |
| 16 | .SH DESCRIPTION |
| 17 | .I Codereview |
| 18 | uploads suggested changes to the code review server |
| 19 | .I codereview.appspot.com |
| 20 | and sends email to reviewers. |
| 21 | It must be used from within a Plan 9 from User Space tree |
| 22 | checked out via Mercurial |
| 23 | (see |
| 24 | .IR hg (1)). |
| 25 | .PP |
| 26 | A developer makes changes to a local copy of the tree |
| 27 | and reviews them locally using |
| 28 | .I hg |
| 29 | .I diff . |
| 30 | When the changes are ready for external review, the |
| 31 | developer creates a review issue by running |
| 32 | .I codereview |
| 33 | naming the files to be reviewed. |
| 34 | .I Codereview |
| 35 | prompts for a Google Accounts user name |
| 36 | and password to log in to |
| 37 | .I http://codereview.appspot.com/ |
| 38 | and create a new review issue. |
| 39 | Once created, it prints a line like |
| 40 | .EX |
| 41 | Issue created. URL: http://codereview.appspot.com/96161 |
| 42 | .EE |
| 43 | among other output. |
| 44 | .PP |
| 45 | The reviewer will likely respond with comments |
| 46 | and suggestions for improving the submission. |
| 47 | After making the changes, reupload by repeating |
| 48 | the |
| 49 | .I codereview |
| 50 | command with the |
| 51 | .B -i |
| 52 | option to specify the issue number |
| 53 | (in the above example, 96161). |
| 54 | .PP |
| 55 | Once the reviewer accepts the changes, they will be applied |
| 56 | automatically using the patch uploaded to the review server. |
| 57 | To update the local tree, run |
| 58 | .I hg |
| 59 | .I pull |
| 60 | with the |
| 61 | .B -u |
| 62 | option. |
| 63 | .SH SEE ALSO |
| 64 | .HR http://codereview.appspot.com/ |
| 65 | .SH BUGS |
| 66 | The |
| 67 | .I codereview |
| 68 | command should be replaced by a proper Mercurial extension. |
| 69 | .PP |
| 70 | Making changes to the repository via patches |
| 71 | discards the executable bit on new shell scripts. |
