From 51d11f04768534a699cb6cf1bfeb54ea167fa84a Mon Sep 17 00:00:00 2001 From: Xavier Delaruelle Date: Tue, 8 Aug 2023 13:34:47 +0200 Subject: [PATCH] doc: desc. MODULES_ERROR_ON_MULTI_LOAD in man/changes --- doc/source/changes.rst | 3 ++- doc/source/module.rst | 14 ++++++++++++++ 2 files changed, 16 insertions(+), 1 deletion(-) diff --git a/doc/source/changes.rst b/doc/source/changes.rst index 63ae6718..6e564efb 100644 --- a/doc/source/changes.rst +++ b/doc/source/changes.rst @@ -948,7 +948,8 @@ The following environment variables appeared on Modules 5. | | :envvar:`MODULES_IGNORE_USER_RC` | +------------+-----------------------------------------------------------------+ | 5.4 | :envvar:`MODULES_STICKY_PURGE`, | -| | :envvar:`MODULES_UNIQUE_NAME_LOADED` | +| | :envvar:`MODULES_UNIQUE_NAME_LOADED`, | +| | :envvar:`MODULES_ERROR_ON_MULTI_LOAD` | +------------+-----------------------------------------------------------------+ Modules Specific Tcl Commands diff --git a/doc/source/module.rst b/doc/source/module.rst index 8497065e..6bed7f57 100644 --- a/doc/source/module.rst +++ b/doc/source/module.rst @@ -4099,6 +4099,20 @@ ENVIRONMENT .. versionadded:: 4.8 +.. envvar:: MODULES_ERROR_ON_MULTI_LOAD + + When loading multiple modulefiles, if one fails to load, ``continue`` to + evaluate remaining modulefiles in list or ``abort`` and withdraw already + loaded modulefiles from list. + + This environment variable value supersedes the default value set in the + :mconfig:`error_on_multi_load` configuration option. It can be defined with + the :subcmd:`config` sub-command. + + .. only:: html + + .. versionadded:: 5.4 + .. envvar:: MODULES_EXTENDED_DEFAULT If set to ``1``, a specified module version is matched against starting