doc: desc. require_via in man/changes/install/other

Signed-off-by: Xavier Delaruelle <xavier.delaruelle@cea.fr>
This commit is contained in:
Xavier Delaruelle
2025-05-18 17:20:15 +02:00
parent 4f0a2111d5
commit 57b70fd99c
4 changed files with 28 additions and 3 deletions

View File

@@ -1732,6 +1732,9 @@ installation.
| | | :option:`--redirect`, | | |
| | | :option:`--no-redirect` | | |
+-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
| :mconfig:`require_via` | ``0`` | :instopt:`--enable-require-via`, | | |
| | | :envvar:`MODULES_REQUIRE_VIA` | | |
+-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
| :mconfig:`reset_target_state` | ``__init__`` | :envvar:`MODULES_RESET_TARGET_STATE`, | | |
+-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
| :mconfig:`run_quarantine` | *Empty by default* | :instopt:`--with-quarantine-vars`, | | |

View File

@@ -1131,6 +1131,10 @@ The following modulefile Tcl commands appeared on Modules 5.
unloaded if both :mconfig:`auto_handling` and :mconfig:`conflict_unload`
configuration options are enabled.
Starting version ``5.6`` unloading a module that enables a modulepath unloads
all loaded modules stored in this modulepath if :mconfig:`require_via`
configuration option is enabled.
:mfcmd:`module unuse<module>`
Starting version ``5.1`` options ``--*-on-unload`` added to the
@@ -1258,7 +1262,7 @@ The following Modules configuration option has been introduced on Modules 5.
| | :mconfig:`logged_events`, :mconfig:`conflict_unload` |
+------------+-----------------------------------------------------------------+
| 5.6 | :mconfig:`spider_output`, :mconfig:`spider_terse_output`, |
| | :mconfig:`spider_indepth` |
| | :mconfig:`spider_indepth`, :mconfig:`require_via` |
+------------+-----------------------------------------------------------------+
:mconfig:`auto_handling`

View File

@@ -1425,6 +1425,21 @@ Module Sub-Commands
.. versionadded:: 5.1
.. mconfig:: require_via
Consider loaded module enabling a modulepath a requirement for loaded
modules stored in this modulepath.
Default value is ``0``. It can be changed at installation time with
:instopt:`--enable-require-via` option. The :envvar:`MODULES_REQUIRE_VIA`
environment variable is defined by :subcmd:`config` sub-command when
changing this configuration option from its default value. See
:envvar:`MODULES_REQUIRE_VIA` description for details.
.. only:: html
.. versionadded:: 5.6
.. mconfig:: reset_target_state
Control behavior of :subcmd:`reset` sub-command. Whether environment should

View File

@@ -37,7 +37,7 @@ table highlights features that are unique to each implementation.
- Modules 5.6
* - * Integration with *rc* shell and *json* structured output
* `Lua modulefile support`_
* `Module hierarchy`_
* `Inactive modules`_
* Save configuration under :envvar:`XDG_CONFIG_HOME`
* `i18n`_
* `Find best module`_
@@ -70,8 +70,8 @@ table highlights features that are unique to each implementation.
* :ref:`Logging activity`
* :command:`envml` launcher
.. _Module hierarchy: https://lmod.readthedocs.io/en/latest/080_hierarchy.html
.. _Lua modulefile support: https://lmod.readthedocs.io/en/latest/050_lua_modulefiles.html
.. _Inactive modules: https://lmod.readthedocs.io/en/latest/010_user.html#module-hierarchy
.. _Find best module: https://lmod.readthedocs.io/en/latest/060_locating.html
.. _i18n: https://lmod.readthedocs.io/en/latest/185_localization.html
.. _Path entry priorities: https://lmod.readthedocs.io/en/latest/077_ref_counting.html#specifying-priorities-for-path-entries
@@ -150,6 +150,8 @@ implementation.
* - `Hook functions`_
- :ref:`Override any internal procedures or set trace hook<Site-specific
configuration>`
* - `Module hierarchy`_
- :ref:`Require via MIGRATING`
* - `Autoswap`_
- :ref:`Conflict unload MIGRATING`
* - |LMOD_DOWNSTREAM_CONFLICTS|_ environment variable
@@ -209,6 +211,7 @@ implementation.
.. _Module properties: https://lmod.readthedocs.io/en/latest/145_properties.html
.. _One name rule: https://lmod.readthedocs.io/en/latest/010_user.html#users-can-only-have-one-version-active-the-one-name-rule
.. _XALT: https://github.com/xalt/xalt
.. _Module hierarchy: https://lmod.readthedocs.io/en/latest/080_hierarchy.html
.. _Autoswap: https://lmod.readthedocs.io/en/latest/060_locating.html#autoswapping-rules
.. |LMOD_DOWNSTREAM_CONFLICTS| replace:: ``LMOD_DOWNSTREAM_CONFLICTS``
.. _LMOD_DOWNSTREAM_CONFLICTS: https://lmod.readthedocs.io/en/latest/090_configuring_lmod.html#configuration-or-cosmic-assign-at-startup