( )⚙ D10398 help: prepend environment variables used in hooks with "$"

This is an archive of the discontinued Mercurial Phabricator instance.

Differential D10398

help: prepend environment variables used in hooks with "$"
ClosedPublic

Authored by aayjaychan on Apr 14 2021, 11:42 AM.

Details

Reviewers
pulkit
Group Reviewers
hg-reviewers
Commits
rHG314386a19cff: help: prepend environment variables used in hooks with "$"
Summary

Most of them have "$" prefix but some don't, so adding it for consistency.

Diff Detail

Repository
rHG Mercurial
Branch
default
Lint
No Linters Available
Unit
No Unit Test Coverage

Revision Contents
Changeset List

PathPackages
Mmercurial/helptext/config.txt (12 lines)

Diff 26854

mercurial/helptext/config.txt

Run before creating a tag. Exit status 0 allows the tag to be Run before creating a tag. Exit status 0 allows the tag to be
created. A non-zero status will cause the tag to fail. The ID of the created. A non-zero status will cause the tag to fail. The ID of the
changeset to tag is in ``$HG_NODE``. The name of tag is in ``$HG_TAG``. The changeset to tag is in ``$HG_NODE``. The name of tag is in ``$HG_TAG``. The
tag is local if ``$HG_LOCAL=1``, or in the repository if ``$HG_LOCAL=0``. tag is local if ``$HG_LOCAL=1``, or in the repository if ``$HG_LOCAL=0``.
``pretxnopen`` ``pretxnopen``
Run before any new repository transaction is open. The reason for the Run before any new repository transaction is open. The reason for the
transaction will be in ``$HG_TXNNAME``, and a unique identifier for the 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 will be in ``$HG_TXNID``. A non-zero status will prevent the
transaction from being opened. transaction from being opened.
``pretxnclose`` ``pretxnclose``
Run right before the transaction is actually finalized. Any repository change Run right before the transaction is actually finalized. Any repository change
will be visible to the hook program. This lets you validate the transaction will be visible to the hook program. This lets you validate the transaction
content or change it. Exit status 0 allows the commit to proceed. A non-zero content or change it. Exit status 0 allows the commit to proceed. A non-zero
status will cause the transaction to be rolled back. The reason for the status will cause the transaction to be rolled back. The reason for the
transaction opening will be in ``$HG_TXNNAME``, and a unique identifier for transaction opening will be in ``$HG_TXNNAME``, and a unique identifier for
the transaction will be in ``HG_TXNID``. The rest of the available data will 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`` vary according the transaction type. New changesets will add ``$HG_NODE``
(the ID of the first added changeset), ``$HG_NODE_LAST`` (the ID of the last (the ID of the first added changeset), ``$HG_NODE_LAST`` (the ID of the last
added changeset), ``$HG_URL`` and ``$HG_SOURCE`` variables. Bookmark and added changeset), ``$HG_URL`` and ``$HG_SOURCE`` variables. Bookmark and
phase changes will set ``HG_BOOKMARK_MOVED`` and ``HG_PHASES_MOVED`` to ``1`` phase changes will set ``$HG_BOOKMARK_MOVED`` and ``$HG_PHASES_MOVED`` to
respectively, etc. ``1`` respectively, etc.
``pretxnclose-bookmark`` ``pretxnclose-bookmark``
Run right before a bookmark change is actually finalized. Any repository Run right before a bookmark change is actually finalized. Any repository
change will be visible to the hook program. This lets you validate the change will be visible to the hook program. This lets you validate the
transaction content or change it. Exit status 0 allows the commit to transaction content or change it. Exit status 0 allows the commit to
proceed. A non-zero status will cause the transaction to be rolled back. proceed. A non-zero status will cause the transaction to be rolled back.
The name of the bookmark will be available in ``$HG_BOOKMARK``, the new The name of the bookmark will be available in ``$HG_BOOKMARK``, the new
bookmark location will be available in ``$HG_NODE`` while the previous bookmark location will be available in ``$HG_NODE`` while the previous
location will be available in ``$HG_OLDNODE``. In case of a bookmark location will be available in ``$HG_OLDNODE``. In case of a bookmark
creation ``$HG_OLDNODE`` will be empty. In case of deletion ``$HG_NODE`` creation ``$HG_OLDNODE`` will be empty. In case of deletion ``$HG_NODE``
will be empty. will be empty.
In addition, the reason for the transaction opening will be in In addition, the reason for the transaction opening will be in
``$HG_TXNNAME``, and a unique identifier for the transaction will be in ``$HG_TXNNAME``, and a unique identifier for the transaction will be in
``HG_TXNID``. ``$HG_TXNID``.
``pretxnclose-phase`` ``pretxnclose-phase``
Run right before a phase change is actually finalized. Any repository change Run right before a phase change is actually finalized. Any repository change
will be visible to the hook program. This lets you validate the transaction will be visible to the hook program. This lets you validate the transaction
content or change it. Exit status 0 allows the commit to proceed. A non-zero content or change it. Exit status 0 allows the commit to proceed. A non-zero
status will cause the transaction to be rolled back. The hook is called status will cause the transaction to be rolled back. The hook is called
multiple times, once for each revision affected by a phase change. multiple times, once for each revision affected by a phase change.
The affected node is available in ``$HG_NODE``, the phase in ``$HG_PHASE`` The affected node is available in ``$HG_NODE``, the phase in ``$HG_PHASE``
while the previous ``$HG_OLDPHASE``. In case of new node, ``$HG_OLDPHASE`` while the previous ``$HG_OLDPHASE``. In case of new node, ``$HG_OLDPHASE``
will be empty. In addition, the reason for the transaction opening will be in will be empty. In addition, the reason for the transaction opening will be in
``$HG_TXNNAME``, and a unique identifier for the transaction will be in ``$HG_TXNNAME``, and a unique identifier for the transaction will be in
``HG_TXNID``. The hook is also run for newly added revisions. In this case ``$HG_TXNID``. The hook is also run for newly added revisions. In this case
the ``$HG_OLDPHASE`` entry will be empty. the ``$HG_OLDPHASE`` entry will be empty.
``txnclose`` ``txnclose``
Run after any repository transaction has been committed. At this Run after any repository transaction has been committed. At this
point, the transaction can no longer be rolled back. The hook will run point, the transaction can no longer be rolled back. The hook will run
after the lock is released. See :hg:`help config.hooks.pretxnclose` for after the lock is released. See :hg:`help config.hooks.pretxnclose` for
details about available variables. details about available variables.