diff options
Diffstat (limited to 'docs/Phabricator.rst')
| -rw-r--r-- | docs/Phabricator.rst | 29 |
1 files changed, 25 insertions, 4 deletions
diff --git a/docs/Phabricator.rst b/docs/Phabricator.rst index 18b2817..8ac9afe 100644 --- a/docs/Phabricator.rst +++ b/docs/Phabricator.rst @@ -5,18 +5,29 @@ Code Reviews with Phabricator .. contents:: :local: -If you prefer to use a web user interface for code reviews, -you can now submit your patches for Clang and LLVM at -`LLVM's Phabricator`_. +If you prefer to use a web user interface for code reviews, you can now submit +your patches for Clang and LLVM at `LLVM's Phabricator`_ instance. + +While Phabricator is a useful tool for some, the relevant -commits mailing list +is the system of record for all LLVM code review. The mailing list should be +added as a subscriber on all reviews, and Phabricator users should be prepared +to respond to free-form comments in mail sent to the commits list. Sign up ------- +To get started with Phabricator, navigate to `http://reviews.llvm.org`_ and +click the power icon in the top right. You can register with a GitHub account, +a Google account, or you can create your own profile. + +Make *sure* that the email address registered with Phabricator is subscribed +to the relevant -commits mailing list. If your are not subscribed to the commit +list, all mail sent by Phabricator on your behalf will be held for moderation. + Note that if you use your Subversion user name as Phabricator user name, Phabricator will automatically connect your submits to your Phabricator user in the `Code Repository Browser`_. - Requesting a review via the command line ---------------------------------------- @@ -90,6 +101,15 @@ a change from Phabricator. Committing a change ------------------- +Arcanist can manage the commit transparently. It will retrieve the description, +reviewers, the ``Differential Revision``, etc from the review and commit it to the repository. + +:: + + arc patch D<Revision> + arc commit --revision D<Revision> + + When committing an LLVM change that has been reviewed using Phabricator, the convention is for the commit message to end with the line: @@ -113,6 +133,7 @@ Status Please let us know whether you like it and what could be improved! .. _LLVM's Phabricator: http://reviews.llvm.org +.. _`http://reviews.llvm.org`: http://reviews.llvm.org .. _Code Repository Browser: http://reviews.llvm.org/diffusion/ .. _Arcanist Quick Start: http://www.phabricator.com/docs/phabricator/article/Arcanist_Quick_Start.html .. _Arcanist User Guide: http://www.phabricator.com/docs/phabricator/article/Arcanist_User_Guide.html |