[Python-checkins] devguide: document existing hooks for commit messages mentioning issues. Closes issue

[eli.bendersky]

http://hg.python.org/devguide/rev/21758f27f98f
changeset:   462:21758f27f98f
user:        Eli Bendersky <eliben at gmail.com>
date:        Wed Nov 16 00:48:23 2011 +0200
summary:
  document existing hooks for commit messages mentioning issues. Closes issue 13388

files:
  committing.rst |  21 +++++++++++++++++++++
  1 files changed, 21 insertions(+), 0 deletions(-)


diff --git a/committing.rst b/committing.rst
--- a/committing.rst
+++ b/committing.rst
@@ -68,6 +68,27 @@
   and the original NEWS entry remains valid, then no additional entry is
   needed.
 
+Mercurial hooks
+'''''''''''''''
+
+Special hooks have been added to the Mercurial repository to enable notifying
+the issue tracker of a commit related to an issue.
+
+A commit message can mention one or several issues in one of the following
+ways::
+
+   #12345
+   issue12345
+   issue 12345
+   bug12345
+   bug 12345
+
+where 12345 is the number of the issue. The commit details (including its
+changeset, branch and commit message) will then be posted as a message to the
+issue's page in the tracker, for each mentioned issue.
+
+If "closes" (or "closed", or "closing") is prepended, the issue is
+automatically closed as "fixed".
 
 Working with Mercurial_
 -----------------------

-- 
Repository URL: http://hg.python.org/devguide