help: document the ''HG_TXNID'' environment variable during hooks
authorPierre-Yves David <pierre-yves.david@fb.com>
Thu, 16 Apr 2015 05:41:07 -0400
changeset 24791 89c5881d692c
parent 24790 baa11dde8c0e
child 24792 7d0421de8de3
help: document the ''HG_TXNID'' environment variable during hooks We forgot to document the new "transaction ID" mechanism.
mercurial/help/config.txt
--- a/mercurial/help/config.txt	Sun Apr 12 01:39:21 2015 -0400
+++ b/mercurial/help/config.txt	Thu Apr 16 05:41:07 2015 -0400
@@ -810,8 +810,9 @@
 
 ``pretxnopen``
   Run before any new repository transaction is open. The reason for the
-  transaction will be in ``$HG_TXNNAME``. A non-zero status will
-  prevent the transaction from being opened.
+  transaction will be in ``$HG_TXNNAME`` and a unique identifier for the
+  transaction will be in ``HG_TXNID``. A non-zero status will prevent the
+  transaction from being opened.
 
 ``pretxnclose``
   Run right before the transaction is actually finalized. Any
@@ -819,11 +820,12 @@
   validate the transaction content or change it. Exit status 0 allows
   the commit to proceed. Non-zero status will cause the transaction to
   be rolled back. The reason for the transaction opening will be in
-  ``$HG_TXNNAME``. The rest of the available data will vary according
-  the transaction type. New changesets will add
-  ``$HG_NODE`` (id of the first added changeset), ``$HG_URL`` and
-  ``$HG_SOURCE`` variables, bookmarks and phases changes will set
-  ``HG_BOOKMARK_MOVED`` and ``HG_PHASES_MOVED`` to ``1``, etc.
+  ``$HG_TXNNAME`` and a unique identifier for the transaction will be in
+  ``HG_TXNID``. The rest of the available data will vary according the
+  transaction type. New changesets will add ``$HG_NODE`` (id of the
+  first added changeset), ``$HG_URL`` and ``$HG_SOURCE`` variables,
+  bookmarks and phases changes will set ``HG_BOOKMARK_MOVED`` and
+  ``HG_PHASES_MOVED`` to ``1``, etc.
 
 ``txnclose``
   Run after any repository transaction has been commited. At this