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,
   9 you can now submit your patches for Clang and LLVM at
  10 `LLVM's Phabricator`_.
  11
  12 Sign up
  13 -------
  14
  15 Sign up with one of the supported OAuth account types. If
  16 you use your Subversion user name as Phabricator user name,
  17 Phabricator will automatically connect your submits to your
  18 Phabricator user in the `Code Repository Browser`_.
  19
  20
  21 Requesting a review via the command line
  22 ----------------------------------------
  23
  24 Phabricator has a tool called *Arcanist* to upload patches from
  25 the command line. To get you set up, follow the
  26 `Arcanist Quick Start`_ instructions.
  27
  28 You can learn more about how to use arc to interact with
  29 Phabricator in the `Arcanist User Guide`_.
  30
  31 Requesting a review via the web interface
  32 -----------------------------------------
  33
  34 The tool to create and review patches in Phabricator is called
  35 *Differential*.
  36
  37 Note that you can upload patches created through various diff tools,
  38 including git and svn. To make reviews easier, please always include
  39 **as much context as possible** with your diff! Don't worry, Phabricator
  40 will automatically send a diff with a smaller context in the review
  41 email, but having the full file in the web interface will help the
  42 reviewer understand your code.
  43
  44 To get a full diff, use one of the following commands (or just use Arcanist
  45 to upload your patch):
  46
  47 * git diff -U999999 other-branch
  48 * svn diff --diff-cmd=diff -x -U999999
  49
  50 To upload a new patch:
  51
  52 * Click *Differential*.
  53 * Click *Create Revision*.
  54 * Paste the text diff or upload the patch file.
  55   Note that TODO
  56 * Leave the drop down on *Create a new Revision...* and click *Continue*.
  57 * Enter a descriptive title and summary; add reviewers and mailing
  58   lists that you want to be included in the review. If your patch is
  59   for LLVM, cc llvm-commits; if your patch is for Clang, cc cfe-commits.
  60 * Click *Save*.
  61
  62 To submit an updated patch:
  63
  64 * Click *Differential*.
  65 * Click *Create Revision*.
  66 * Paste the updated diff.
  67 * Select the review you want to from the *Attach To* dropdown and click
  68   *Continue*.
  69 * Click *Save*.
  70
  71 Reviewing code with Phabricator
  72 -------------------------------
  73
  74 Phabricator allows you to add inline comments as well as overall comments
  75 to a revision. To add an inline comment, select the lines of code you want
  76 to comment on by clicking and dragging the line numbers in the diff pane.
  77
  78 You can add overall comments or submit your comments at the bottom of the page.
  79
  80 Phabricator has many useful features, for example allowing you to select
  81 diffs between different versions of the patch as it was reviewed in the
  82 *Revision Update History*. Most features are self descriptive - explore, and
  83 if you have a question, drop by on #llvm in IRC to get help.
  84
  85 Status
  86 ------
  87
  88 Currently, we're testing Phabricator for use with Clang/LLVM. Please let us
  89 know whether you like it and what could be improved!
  90
  91 .. _LLVM's Phabricator: http://llvm-reviews.chandlerc.com
  92 .. _Code Repository Browser: http://llvm-reviews.chandlerc.com/diffusion/
  93 .. _Arcanist Quick Start: http://www.phabricator.com/docs/phabricator/article/Arcanist_Quick_Start.html
  94 .. _Arcanist User Guide: http://www.phabricator.com/docs/phabricator/article/Arcanist_User_Guide.html