From cde90e005a1352e042b505dbfc90ba3c42698331 Mon Sep 17 00:00:00 2001 From: Xavier Delaruelle Date: Wed, 18 Jun 2025 07:38:30 +0200 Subject: [PATCH] doc: desc. provide in man/changes Signed-off-by: Xavier Delaruelle --- doc/source/changes.rst | 3 ++- doc/source/module.rst | 5 +++++ doc/source/modulefile.rst | 19 +++++++++++++++++++ 3 files changed, 26 insertions(+), 1 deletion(-) diff --git a/doc/source/changes.rst b/doc/source/changes.rst index 879a5e9b..1c562213 100644 --- a/doc/source/changes.rst +++ b/doc/source/changes.rst @@ -1093,7 +1093,8 @@ The following modulefile Tcl commands appeared on Modules 5. | | :mfcmd:`lsb-release` | +------------+-----------------------------------------------------------------+ | 5.6 | :mfcmd:`depends-on-any`, :mfcmd:`module-help`, | -| | :mfcmd:`module-warn`, :mfcmd:`haveDynamicMPATH` | +| | :mfcmd:`module-warn`, :mfcmd:`haveDynamicMPATH`, | +| | :mfcmd:`provide` | +------------+-----------------------------------------------------------------+ :mfcmd:`system`, :mfcmd:`is-used` diff --git a/doc/source/module.rst b/doc/source/module.rst index 9c886bc4..21da11aa 100644 --- a/doc/source/module.rst +++ b/doc/source/module.rst @@ -3490,6 +3490,9 @@ Extra match search is triggered when: * :ref:`Module variants` and their available values have to be reported in avail and spider outputs (see :option:`--output`/:option:`-o` option): extra match search is triggered to collect variant information +* Provided module aliases have to be reported in avail and spider outputs (see + :option:`--output`/:option:`-o` option): extra match search is triggered to + collect these module aliases defined within modulefiles * Module variant is specified in search query: extra match search is triggered to collect variant information then match them against variant specified in query @@ -3526,6 +3529,8 @@ to build and use :ref:`Module cache` to improve search speed. .. versionchanged:: 5.6 Support for :subcmd:`spider` sub-command added + .. versionchanged:: 5.6 + Extra match search triggered when reporting provided module aliases .. _collections: diff --git a/doc/source/modulefile.rst b/doc/source/modulefile.rst index b2d07019..7be4ab8a 100644 --- a/doc/source/modulefile.rst +++ b/doc/source/modulefile.rst @@ -1302,6 +1302,25 @@ the *modulefile* is being loaded. .. versionchanged:: 5.5 Option ``--modulepath`` added +.. mfcmd:: provide modulefile... + + Define each specified *modulefile* as a module alias of currently evaluating + module. :mfcmd:`provide` command helps to declare the additional elements + included in a modulefile. + + The :mfcmd:`provide` command should be paired with a :mfcmd:`conflict` + command if the specified alias should be uniquely provided in the currently + loaded environment. + + Note: A module alias defined using :mfcmd:`provide` command will not be + recognized during module resolution. It is recommended to use the + :mfcmd:`module-alias` command to define an alias that points to the default + resolution target. + + .. only:: html + + .. versionadded:: 5.6 + .. mfcmd:: pushenv variable value Set environment *variable* to *value* and save previous value of *variable*