Difference between revisions of "Code Review Tool"

From Second Life Wiki
Jump to navigation Jump to search
m
Line 10: Line 10:
Access to the system requires that you set up an account, which you can do on your own from the login page, or by going directly to the [https://codereview.secondlife.com/account/register/ account registration page].
Access to the system requires that you set up an account, which you can do on your own from the login page, or by going directly to the [https://codereview.secondlife.com/account/register/ account registration page].


==How To Use ReviewBoard==
==Post Code To Be Reviewed==


Use the command:
Prepare your change in a local working hg repository.  It will be easier to keep track of outstanding reviews if you commit your change to that repository before posting it for review.


hg diff -r ''commit''
Once you have a local copy of the change, there are two ways to post it for review:
* [[#Manual Upload|Manual Upload]] using the web page interface
* [[#post-review|post-review]] command line tool
Either way, you must [[#Publish Your Review|Publish Your Review]]


to create a patch that shows your change, and upload that patch on the '''Create A Review''' page.
===Manual Upload===
 
To create a patch that shows your change, execute the following command from the top level of your repository:
 
hg diff -r ''commit'' > DIFF
 
where ''commit'' is the revision identifier for your change (if you have not made any new changes, this can just be <tt>tip</tt>).
 
===post-review===


There is a command line tool called '''post-review''', but it is not very mature and whether or not it works can depend on how you created your mercurial repository.  ''I plan to work on improving this asap - Oz''
There is a command line tool called '''post-review''', but it is not very mature and whether or not it works can depend on how you created your mercurial repository.  ''I plan to work on improving this asap - Oz''


===Commenting===
===Publish Your Review===
 
 
==Commenting==


Whenever possible, comment by selecting lines in the file and entering a comment.  It makes it much more specific than if you post a general comment.
Whenever possible, comment by selecting lines in the file and entering a comment.  It makes it much more specific than if you post a general comment.

Revision as of 09:35, 14 December 2010

Given enough eyeballs, all bugs are shallow
- Linus' Law, according to Eric S. Raymond

Linden Lab maintains an instance of the ReviewBoard code review tool at codereview.secondlife.com to be used for reviewing any proposed changes to any of our open source projects.

Use of this system is limited to developers who have executed a Second Life Viewer Contribution Agreement. Any changes or comments posted to the tool are Contributions as defined by that Agreement.

Accounts

Access to the system requires that you set up an account, which you can do on your own from the login page, or by going directly to the account registration page.

Post Code To Be Reviewed

Prepare your change in a local working hg repository. It will be easier to keep track of outstanding reviews if you commit your change to that repository before posting it for review.

Once you have a local copy of the change, there are two ways to post it for review:

Either way, you must Publish Your Review

Manual Upload

To create a patch that shows your change, execute the following command from the top level of your repository:

hg diff -r commit > DIFF

where commit is the revision identifier for your change (if you have not made any new changes, this can just be tip).

post-review

There is a command line tool called post-review, but it is not very mature and whether or not it works can depend on how you created your mercurial repository. I plan to work on improving this asap - Oz

Publish Your Review

Commenting

Whenever possible, comment by selecting lines in the file and entering a comment. It makes it much more specific than if you post a general comment.