X-Git-Url: http://plrg.eecs.uci.edu/git/?a=blobdiff_plain;f=docs%2FPhabricator.rst;h=af1e4429fda9b974bbb11eefb5da7945bc42dd43;hb=a769f56ac58b9ab9aacbd0c7198cd19272254855;hp=44b0e06367d57e514ead997fbe0c80aa3007c1ba;hpb=181ebadd3a3da3412717b25988c6f6c255984630;p=oota-llvm.git diff --git a/docs/Phabricator.rst b/docs/Phabricator.rst index 44b0e06367d..af1e4429fda 100644 --- a/docs/Phabricator.rst +++ b/docs/Phabricator.rst @@ -66,7 +66,7 @@ To upload a new patch: * Leave the drop down on *Create a new Revision...* and click *Continue*. * Enter a descriptive title and summary. The title and summary are usually in the form of a :ref:`commit message `. -* Add reviewers and mailing +* Add reviewers (see below for advice) and subscribe mailing lists that you want to be included in the review. If your patch is for LLVM, add llvm-commits as a Subscriber; if your patch is for Clang, add cfe-commits. @@ -83,6 +83,24 @@ To submit an updated patch: * Leave the Repository and Project fields blank. * Add comments about the changes in the new diff. Click *Save*. +Choosing reviewers: You typically pick one or two people as initial reviewers. +This choice is not crucial, because you are merely suggesting and not requiring +them to participate. Many people will see the email notification on cfe-commits +or llvm-commits, and if the subject line suggests the patch is something they +should look at, they will. + +Here are a couple of ways to pick the initial reviewer(s): + +* Use ``svn blame`` and the commit log to find names of people who have + recently modified the same area of code that you are modifying. +* Look in CODE_OWNERS.TXT to see who might be responsible for that area. +* If you've discussed the change on a dev list, the people who participated + might be appropriate reviewers. + +Even if you think the code owner is the busiest person in the world, it's still +okay to put them as a reviewer. Being the code owner means they have accepted +responsibility for making sure the review happens. + Reviewing code with Phabricator ------------------------------- @@ -118,7 +136,7 @@ reviewers, the ``Differential Revision``, etc from the review and commit it to t arc commit --revision D -When committing an LLVM change that has been reviewed using +When committing a change that has been reviewed using Phabricator, the convention is for the commit message to end with the line: @@ -135,6 +153,12 @@ This allows people reading the version history to see the review for context. This also allows Phabricator to detect the commit, close the review, and add a link from the review to the commit. +If you use ``git`` or ``svn`` to commit the change and forget to add the line +to your commit message, you should close the review manually. In the web UI, +under "Leap Into Action" put the SVN revision number in the Comment, set the +Action to "Close Revision" and click Submit. Note the review must have been +Accepted first. + Abandoning a change -------------------