mirror of
https://github.com/RPCS3/llvm-mirror.git
synced 2024-11-22 10:42:39 +01:00
Adds Phabricator documentation. This is a first step that answers many questions we have seen.
llvm-svn: 165736
This commit is contained in:
parent
d8b76fdc50
commit
aecda1c8d9
@ -137,6 +137,10 @@ reviewees. If someone is kind enough to review your code, you should return the
|
||||
favor for someone else. Note that anyone is welcome to review and give feedback
|
||||
on a patch, but only people with Subversion write access can approve it.
|
||||
|
||||
There is a web based code review tool that can optionally be used
|
||||
for code reviews. See the documentation on `Code Reviews with
|
||||
Phabricator <Phabricator.html>`_.
|
||||
|
||||
Code Owners
|
||||
-----------
|
||||
|
||||
|
96
docs/Phabricator.rst
Normal file
96
docs/Phabricator.rst
Normal file
@ -0,0 +1,96 @@
|
||||
.. _Phabricator:
|
||||
.. _LLVM's Phabricator: http://llvm-reviews.chandlerc.com
|
||||
.. _Code Repository Browser: http://llvm-reviews.chandlerc.com/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
|
||||
|
||||
|
||||
=============================
|
||||
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`_.
|
||||
|
||||
Sign up
|
||||
-------
|
||||
|
||||
Sign up with one of the supported OAuth account types. 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
|
||||
----------------------------------------
|
||||
|
||||
Phabricator has a tool called *Arcanist* to upload patches from
|
||||
the command line. To get you set up, follow the
|
||||
`Arcanist Quick Start`_ instructions.
|
||||
|
||||
You can learn more about how to use arc to interact with
|
||||
Phabricator in the `Arcanist User Guide`_.
|
||||
|
||||
Requesting a review via the web interface
|
||||
-----------------------------------------
|
||||
|
||||
The tool to create and review patches in Phabricator is called
|
||||
*Differential*.
|
||||
|
||||
Note that you can upload patches created through various diff tools,
|
||||
including git and svn. To make reviews easier, please always include
|
||||
**as much context as possible** with your diff! Don't worry, Phabricator
|
||||
will automatically send a diff with a smaller context in the review
|
||||
email, but having the full file in the web interface will help the
|
||||
reviewer understand your code.
|
||||
|
||||
To get a full diff, use one of the following commands (or just use Arcanist
|
||||
to upload your patch):
|
||||
|
||||
* git diff -U999999 other-branch
|
||||
* svn diff --diff-cmd=diff -x -U999999
|
||||
|
||||
To upload a new patch:
|
||||
|
||||
* Click *Differential*.
|
||||
* Click *Create Revision*.
|
||||
* Paste the text diff or upload the patch file.
|
||||
Note that TODO
|
||||
* Leave the drop down on *Create a new Revision...* and click *Continue*.
|
||||
* Enter a descriptive title and summary; add reviewers and mailing
|
||||
lists that you want to be included in the review. If your patch is
|
||||
for LLVM, cc llvm-commits; if your patch is for Clang, cc cfe-commits.
|
||||
* Click *Save*.
|
||||
|
||||
To submit an updated patch:
|
||||
|
||||
* Click *Differential*.
|
||||
* Click *Create Revision*.
|
||||
* Paste the updated diff.
|
||||
* Select the review you want to from the *Attach To* dropdown and click
|
||||
*Continue*.
|
||||
* Click *Save*.
|
||||
|
||||
Reviewing code with Phabricator
|
||||
-------------------------------
|
||||
|
||||
Phabricator allows you to add inline comments as well as overall comments
|
||||
to a revision. To add an inline comment, select the lines of code you want
|
||||
to comment on by clicking and dragging the line numbers in the diff pane.
|
||||
|
||||
You can add overall comments or submit your comments at the bottom of the page.
|
||||
|
||||
Phabricator has many useful features, for example allowing you to select
|
||||
diffs between different versions of the patch as it was reviewed in the
|
||||
*Revision Update History*. Most features are self descriptive - explore, and
|
||||
if you have a question, drop by on #llvm in IRC to get help.
|
||||
|
||||
Status
|
||||
------
|
||||
|
||||
Currently, we're testing Phabricator for use with Clang/LLVM. Please let us
|
||||
know whether you like it and what could be improved!
|
Loading…
Reference in New Issue
Block a user