maxjhandsome
/
llvm-project
forked from OSchip/llvm-project
1
0
Fork 0
Code Issues Pull Requests Packages Releases Wiki Activity

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.

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

llvm-svn: 201160
This commit is contained in:
Mark Seaborn 2014-02-11 16:58:03 +00:00
parent 5a188549ad
commit 6e15ee85d1
1 changed files with 20 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
llvm/docs/Phabricator.rst
View File

@ -94,6 +94,26 @@ when a review changes state, for example by clicking "Accept Revision" in
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
------