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

[Mark Seaborn]

Hi chandlerc, klimek,

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

I noticed this convention from the commit logs.  It seems like it
would be useful to document it, to encourage other committers to link
back to code reviews in their commits.


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

Files:
  docs/Phabricator.rst

Index: docs/Phabricator.rst
===================================================================
--- docs/Phabricator.rst
+++ docs/Phabricator.rst
@@ -94,6 +94,22 @@
 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, the commit message should end with the line:
+
+::
+
+  Differential Revision: <URL>
+
+where ``<URL>`` is the URL for the code review, starting with
+``http://llvm-reviews.chandlerc.com/``.
+
+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.1.patch
Type: text/x-patch
Size: 756 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20140203/8477fad3/attachment.bin>