[PATCH] Add a note about using "Differential Revision:" in commit messages

Mark Seaborn mseaborn at chromium.org
Wed Feb 5 13:46:11 PST 2014


  Changed wording; mentioned Arcanist.

Hi chandlerc, klimek,

http://llvm-reviews.chandlerc.com/D2678

CHANGE SINCE LAST DIFF
  http://llvm-reviews.chandlerc.com/D2678?vs=6833&id=6903#toc

Files:
  docs/Phabricator.rst

Index: docs/Phabricator.rst
===================================================================
--- docs/Phabricator.rst
+++ docs/Phabricator.rst
@@ -94,6 +94,26 @@
 the web interface. Thus, please type LGTM into the comment box to accept
 a change from Phabricator.
 
+Committing a change
+-------------------
+
+When committing an LLVM change that has been reviewed using
+Phabricator, the convention is for the commit message to end with the
+line:
+
+::
+
+  Differential Revision: <URL>
+
+where ``<URL>`` is the URL for the code review, starting with
+``http://llvm-reviews.chandlerc.com/``.
+
+Note that Arcanist will add this automatically.
+
+This allows people reading the version history to see the review for
+context.  This also allows Phabricator to detect the commit, close the
+review, and add a link from the review to the commit.
+
 Status
 ------
-------------- next part --------------
A non-text attachment was scrubbed...
Name: D2678.2.patch
Type: text/x-patch
Size: 868 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20140205/2433291c/attachment.bin>


More information about the llvm-commits mailing list