Skip to content

Commit

Permalink
Document _REZ_NO_KILLPG, _REZ_QUIET_ON_SIG and REZ_LOGGING_CONF (#1570)
Browse files Browse the repository at this point in the history
Signed-off-by: Jean-Christophe Morin <[email protected]>
  • Loading branch information
JeanChristopheMorinPerso authored Nov 10, 2023
1 parent 1deb44a commit 5ac6b89
Showing 1 changed file with 22 additions and 3 deletions.
25 changes: 22 additions & 3 deletions docs/source/environment.rst
Original file line number Diff line number Diff line change
Expand Up @@ -243,11 +243,30 @@ operation of rez.
If set to a non-empty string, this prevents rez from
cleaning up any temporary directories. This is for debugging purposes.

.. envvar:: REZ_ENV_PROMPT

See the :data:`set_prompt` and :data:`prefix_prompt` settings.

.. envvar:: REZ_LOGGING_CONF

Path to a file that will be consumed by :func:`logging.config.fileConfig` to configure
the logger.

Development Environment Variables
=================================

.. envvar:: REZ_SIGUSR1_ACTION

If you set this to ``print_stack``, rez will prints its
current stacktrace to stdout if sent a USR1 signal. This is for debugging purposes.
current stacktrace to stdout if sent a USR1 signal. This is for debugging purposes only.

.. envvar:: REZ_ENV_PROMPT
.. envvar:: _REZ_NO_KILLPG

See the :data:`set_prompt` and :data:`prefix_prompt` settings.
By default, rez will try to kill its process group when it receives a :data:`SIGINT <signal.SIGINT>`
or :data:`SIGTERM <signal.SIGTERM>` signal. Setting ``_REZ_NO_KILLPG`` to either "1", "true", "on"
or "yes" disables this behavior. This is handy when developing rez itself.

.. envvar:: _REZ_QUIET_ON_SIG

Print a message if rez receives a :data:`SIGINT <signal.SIGINT>`
or :data:`SIGTERM <signal.SIGTERM>` signal.

0 comments on commit 5ac6b89

Please sign in to comment.