diff options
author | James Y Knight <jyknight@google.com> | 2019-01-14 22:27:32 +0000 |
---|---|---|
committer | James Y Knight <jyknight@google.com> | 2019-01-14 22:27:32 +0000 |
commit | 786558882cb649051a94e9fd1753fd8699fa6dac (patch) | |
tree | cda996450105e3e92a380c3e5c1bf062166e5713 /llvm/docs/Phabricator.rst | |
parent | 5885eec35ad501fb97d8946300b8fccbda4b3581 (diff) | |
download | bcm5719-llvm-786558882cb649051a94e9fd1753fd8699fa6dac.tar.gz bcm5719-llvm-786558882cb649051a94e9fd1753fd8699fa6dac.zip |
Update GettingStarted guide to recommend that people use the new
official Git repository.
Remove the directions for using git-svn, and demote the prominence of
the svn instructions.
Also, fix a few other issues while I'm in there:
* Mention LLVM_ENABLE_PROJECTS more.
* Getting started doesn't need to mention test-suite, but should
mention clang and the other projects.
* Remove mentions of "configure", since that's long gone.
I've also adjusted a few other mentions of svn to point to github, but
have not done so comprehensively.
Differential Revision: https://reviews.llvm.org/D56654
llvm-svn: 351130
Diffstat (limited to 'llvm/docs/Phabricator.rst')
-rw-r--r-- | llvm/docs/Phabricator.rst | 67 |
1 files changed, 34 insertions, 33 deletions
diff --git a/llvm/docs/Phabricator.rst b/llvm/docs/Phabricator.rst index 640e1611da6..ca23ab3f130 100644 --- a/llvm/docs/Phabricator.rst +++ b/llvm/docs/Phabricator.rst @@ -1,3 +1,5 @@ +.. _phabricator-reviews: + ============================= Code Reviews with Phabricator ============================= @@ -16,7 +18,7 @@ to respond to free-form comments in mail sent to the commits list. 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. @@ -151,7 +153,7 @@ ends with the line: 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 @@ -162,11 +164,11 @@ be added automatically. If you don't want to use Arcanist, you can add the ``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 @@ -174,24 +176,9 @@ that you close the review manually. In the web UI, under "Leap Into Action" put 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): @@ -205,17 +192,31 @@ This will create a new branch called ``arcpatch-D<Revision>`` based on the 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 ------------------- @@ -241,9 +242,9 @@ requests. We're looking into what the right long-term hosting for this is, but 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/ |