Mercurial > hg > CbC > CbC_llvm
diff docs/Phabricator.rst @ 148:63bd29f05246
merged
author | Shinji KONO <kono@ie.u-ryukyu.ac.jp> |
---|---|
date | Wed, 14 Aug 2019 19:46:37 +0900 |
parents | c2174574ed3a |
children |
line wrap: on
line diff
--- a/docs/Phabricator.rst Sun Dec 23 19:23:36 2018 +0900 +++ b/docs/Phabricator.rst Wed Aug 14 19:46:37 2019 +0900 @@ -1,3 +1,5 @@ +.. _phabricator-reviews: + ============================= Code Reviews with Phabricator ============================= @@ -16,7 +18,7 @@ Sign up ------- -To get started with Phabricator, navigate to `http://reviews.llvm.org`_ and +To get started with Phabricator, navigate to `https://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. @@ -94,6 +96,12 @@ or llvm-commits, and if the subject line suggests the patch is something they should look at, they will. + +.. _finding-potential-reviewers: + +Finding potential reviewers +--------------------------- + Here are a couple of ways to pick the initial reviewer(s): * Use ``svn blame`` and the commit log to find names of people who have @@ -145,7 +153,7 @@ Differential Revision: <URL> where ``<URL>`` is the URL for the code review, starting with -``http://reviews.llvm.org/``. +``https://reviews.llvm.org/``. This allows people reading the version history to see the review for context. This also allows Phabricator to detect the commit, close the @@ -156,11 +164,11 @@ ``Differential Revision`` line (as the last line) to the commit message yourself. -Using the Arcanist tool can simplify the process of committing reviewed code -as it will retrieve reviewers, the ``Differential Revision``, etc from the review -and place it in the commit message. Several methods of using Arcanist to commit -code are given below. If you do not wish to use Arcanist then simply commit -the reviewed patch as you would normally. +Using the Arcanist tool can simplify the process of committing reviewed code as +it will retrieve reviewers, the ``Differential Revision``, etc from the review +and place it in the commit message. You may also commit an accepted change +directly using ``git llvm push``, per the section in the :ref:`getting started +guide <commit_from_git>`. Note that if you commit the change without using Arcanist and forget to add the ``Differential Revision`` line to your commit message then it is recommended @@ -168,24 +176,9 @@ the SVN revision number in the Comment, set the Action to "Close Revision" and click Submit. Note the review must have been Accepted first. -Subversion and Arcanist -^^^^^^^^^^^^^^^^^^^^^^^ -On a clean Subversion working copy run the following (where ``<Revision>`` is -the Phabricator review number): - -:: - - arc patch D<Revision> - arc commit --revision D<Revision> - -The first command will take the latest version of the reviewed patch and apply it to the working -copy. The second command will commit this revision to trunk. - -git-svn and Arcanist -^^^^^^^^^^^^^^^^^^^^ - -This presumes that the git repository has been configured as described in :ref:`developers-work-with-git-svn`. +Committing someone's change from Phabricator +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ On a clean Git repository on an up to date ``master`` branch run the following (where ``<Revision>`` is the Phabricator review number): @@ -199,17 +192,31 @@ current ``master`` and will create a commit corresponding to ``D<Revision>`` with a commit message derived from information in the Phabricator review. -Check you are happy with the commit message and amend it if necessary. Now switch to -the ``master`` branch and add the new commit to it and commit it to trunk. This -can be done by running the following: +Check you are happy with the commit message and amend it if necessary. Then, +make sure the commit is up-to-date, and commit it. This can be done by running +the following: :: - git checkout master - git merge --ff-only arcpatch-D<Revision> - git svn dcommit + git pull --rebase origin master + git show # Ensure the patch looks correct. + ninja check-$whatever # Rerun the appropriate tests if needed. + git llvm push + +Subversion and Arcanist (deprecated) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +To download a change from Phabricator and commit it with subversion, you should +first make sure you have a clean working directory. Then run the following +(where ``<Revision>`` is the Phabricator review number): +:: + + arc patch D<Revision> + arc commit --revision D<Revision> + +The first command will take the latest version of the reviewed patch and apply +it to the working copy. The second command will commit this revision to trunk. Abandoning a change ------------------- @@ -235,9 +242,9 @@ note that it is a derivative of an existing open source project, and so not trivially a good fit for an official LLVM project. -.. _LLVM's Phabricator: http://reviews.llvm.org -.. _`http://reviews.llvm.org`: http://reviews.llvm.org -.. _Code Repository Browser: http://reviews.llvm.org/diffusion/ +.. _LLVM's Phabricator: https://reviews.llvm.org +.. _`https://reviews.llvm.org`: https://reviews.llvm.org +.. _Code Repository Browser: https://reviews.llvm.org/diffusion/ .. _Arcanist Quick Start: https://secure.phabricator.com/book/phabricator/article/arcanist_quick_start/ .. _Arcanist User Guide: https://secure.phabricator.com/book/phabricator/article/arcanist/ .. _llvm-reviews GitHub project: https://github.com/r4nt/llvm-reviews/