From 5ac6b899b62fbc0b72d8aa3c8a5b414979069d41 Mon Sep 17 00:00:00 2001 From: Jean-Christophe Morin <38703886+JeanChristopheMorinPerso@users.noreply.github.com> Date: Thu, 9 Nov 2023 19:19:59 -0500 Subject: [PATCH] Document _REZ_NO_KILLPG, _REZ_QUIET_ON_SIG and REZ_LOGGING_CONF (#1570) Signed-off-by: Jean-Christophe Morin --- docs/source/environment.rst | 25 ++++++++++++++++++++++--- 1 file changed, 22 insertions(+), 3 deletions(-) diff --git a/docs/source/environment.rst b/docs/source/environment.rst index 279db3db8..78c58cd5a 100644 --- a/docs/source/environment.rst +++ b/docs/source/environment.rst @@ -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 ` + or :data:`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 ` + or :data:`SIGTERM ` signal.