[PATCH] D15801: Improve the documentation on committing code reviewed on Phabricator to trunk.

Manuel Klimek via llvm-commits llvm-commits at lists.llvm.org
Tue Jan 5 03:43:02 PST 2016


klimek added inline comments.

================
Comment at: docs/Phabricator.rst:130-136
@@ -129,3 +129,9 @@
 
-Arcanist can manage the commit transparently. It will retrieve the description,
-reviewers, the ``Differential Revision``, etc from the review and commit it to the repository.
+Once a patch has been reviewed and approved on Phabricator it can then be
+committed to trunk.  There are multiple workflows to achieve this. Whichever
+method you follow you must ensure that your commit message ends with the line:
+
+::
+
+  Differential Revision: <URL>
+
----------------
I would phrase that less strongly. Remember that email is still the only system of record, so there's no requirement to make phab auto-close issues.

I'd probably rephrase to something like:
Note that you can get phabricator to automatically close the review when it finds the following line in the commit message:
...

================
Comment at: docs/Phabricator.rst:145-147
@@ +144,5 @@
+
+Note that if you use the Arcanist tool the ``Differential Revision`` line will
+be added automatically. If you don't want to use Arcanist, you **must** add
+the ``Differential Revision`` line to the commit message yourself.
+
----------------
Drop the **must**, it really is optional.


http://reviews.llvm.org/D15801





More information about the llvm-commits mailing list