docs/Phabricator.rst

   1 =============================
   2 Code Reviews with Phabricator
   3 =============================
   4
   5 .. contents::
   6   :local:
   7
   8 If you prefer to use a web user interface for code reviews, you can now submit
   9 your patches for Clang and LLVM at `LLVM's Phabricator`_ instance.
  10
  11 While Phabricator is a useful tool for some, the relevant -commits mailing list
  12 is the system of record for all LLVM code review. The mailing list should be
  13 added as a subscriber on all reviews, and Phabricator users should be prepared
  14 to respond to free-form comments in mail sent to the commits list.
  15
  16 Sign up
  17 -------
  18
  19 To get started with Phabricator, navigate to `http://reviews.llvm.org`_ and
  20 click the power icon in the top right. You can register with a GitHub account,
  21 a Google account, or you can create your own profile.
  22
  23 Make *sure* that the email address registered with Phabricator is subscribed
  24 to the relevant -commits mailing list. If your are not subscribed to the commit
  25 list, all mail sent by Phabricator on your behalf will be held for moderation.
  26
  27 Note that if you use your Subversion user name as Phabricator user name,
  28 Phabricator will automatically connect your submits to your Phabricator user in
  29 the `Code Repository Browser`_.
  30
  31 Requesting a review via the command line
  32 ----------------------------------------
  33
  34 Phabricator has a tool called *Arcanist* to upload patches from
  35 the command line. To get you set up, follow the
  36 `Arcanist Quick Start`_ instructions.
  37
  38 You can learn more about how to use arc to interact with
  39 Phabricator in the `Arcanist User Guide`_.
  40
  41 Requesting a review via the web interface
  42 -----------------------------------------
  43
  44 The tool to create and review patches in Phabricator is called
  45 *Differential*.
  46
  47 Note that you can upload patches created through various diff tools,
  48 including git and svn. To make reviews easier, please always include
  49 **as much context as possible** with your diff! Don't worry, Phabricator
  50 will automatically send a diff with a smaller context in the review
  51 email, but having the full file in the web interface will help the
  52 reviewer understand your code.
  53
  54 To get a full diff, use one of the following commands (or just use Arcanist
  55 to upload your patch):
  56
  57 * ``git diff -U999999 other-branch``
  58 * ``svn diff --diff-cmd=diff -x -U999999``
  59
  60 To upload a new patch:
  61
  62 * Click *Differential*.
  63 * Click *Create Diff*.
  64 * Paste the text diff or upload the patch file.
  65   Note that TODO
  66 * Leave the drop down on *Create a new Revision...* and click *Continue*.
  67 * Enter a descriptive title and summary; add reviewers and mailing
  68   lists that you want to be included in the review. If your patch is
  69   for LLVM, add llvm-commits as a subscriber; if your patch is for Clang,
  70   add cfe-commits.
  71 * Click *Save*.
  72
  73 To submit an updated patch:
  74
  75 * Click *Differential*.
  76 * Click *Create Diff*.
  77 * Paste the updated diff.
  78 * Select the review you want to from the *Attach To* dropdown and click
  79   *Continue*.
  80 * Click *Save*.
  81
  82 Reviewing code with Phabricator
  83 -------------------------------
  84
  85 Phabricator allows you to add inline comments as well as overall comments
  86 to a revision. To add an inline comment, select the lines of code you want
  87 to comment on by clicking and dragging the line numbers in the diff pane.
  88 When you have added all your comments, scroll to the bottom of the page and
  89 click the Submit button.
  90
  91 You can add overall comments in the text box at the bottom of the page.
  92 When you're done, click the Submit button.
  93
  94 Phabricator has many useful features, for example allowing you to select
  95 diffs between different versions of the patch as it was reviewed in the
  96 *Revision Update History*. Most features are self descriptive - explore, and
  97 if you have a question, drop by on #llvm in IRC to get help.
  98
  99 Note that as e-mail is the system of reference for code reviews, and some
 100 people prefer it over a web interface, we do not generate automated mail
 101 when a review changes state, for example by clicking "Accept Revision" in
 102 the web interface. Thus, please type LGTM into the comment box to accept
 103 a change from Phabricator.
 104
 105 Committing a change
 106 -------------------
 107
 108 Arcanist can manage the commit transparently. It will retrieve the description,
 109 reviewers, the ``Differential Revision``, etc from the review and commit it to the repository.
 110
 111 ::
 112
 113   arc patch D<Revision>
 114   arc commit --revision D<Revision>
 115
 116
 117 When committing an LLVM change that has been reviewed using
 118 Phabricator, the convention is for the commit message to end with the
 119 line:
 120
 121 ::
 122
 123   Differential Revision: <URL>
 124
 125 where ``<URL>`` is the URL for the code review, starting with
 126 ``http://reviews.llvm.org/``.
 127
 128 Note that Arcanist will add this automatically.
 129
 130 This allows people reading the version history to see the review for
 131 context.  This also allows Phabricator to detect the commit, close the
 132 review, and add a link from the review to the commit.
 133
 134 Abandoning a change
 135 -------------------
 136
 137 If you decide you should not commit the patch, you should explicitly abandon
 138 the review so that reviewers don't think it is still open. In the web UI,
 139 scroll to the bottom of the page where normally you would enter an overall
 140 comment. In the drop-down Action list, which defaults to "Comment," you should
 141 select "Abandon Revision" and then enter a comment explaining why. Click the
 142 Submit button to finish closing the review.
 143
 144 Status
 145 ------
 146
 147 Please let us know whether you like it and what could be improved!
 148
 149 .. _LLVM's Phabricator: http://reviews.llvm.org
 150 .. _`http://reviews.llvm.org`: http://reviews.llvm.org
 151 .. _Code Repository Browser: http://reviews.llvm.org/diffusion/
 152 .. _Arcanist Quick Start: http://www.phabricator.com/docs/phabricator/article/Arcanist_Quick_Start.html
 153 .. _Arcanist User Guide: http://www.phabricator.com/docs/phabricator/article/Arcanist_User_Guide.html