docs/Phabricator.rst

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