envmodules/modules
1
0
Fork 0
mirror of https://github.com/envmodules/modules.git synced 2026-05-30 00:12:31 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

doc: desc. always-load in NEWS/changes/man

Browse Source
This commit is contained in:
Xavier Delaruelle
2021-12-17 07:15:18 +01:00
parent 267d5ada20
commit 45239f61ca
3 changed files with 25 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
NEWS.rst
View File

@@ -99,6 +99,9 @@ Modules 5.1.0 (not yet released)
are getting unloaded. Update default :mconfig:`tag_abbrev` configuration
option to add an abbreviation for the new tag (``kL``) and default light and
dark color palettes.
* Add the :mfcmd:`always-load` modulefile command for compatibility with Lmod
Tcl modulefiles. This command loads designated modulefile and applies the
``keep-loaded`` tag to it.
.. _Code of conduct: https://github.com/cea-hpc/modules/blob/master/CODE_OF_CONDUCT.md

2
doc/source/changes.rst
View File

@@ -870,7 +870,7 @@ The following modulefile Tcl commands appeared on Modules 5.
| 5.1 | :mfcmd:`add-property`, :mfcmd:`remove-property`, |
| | :mfcmd:`extensions`, :mfcmd:`prereq-any`, |
| | :mfcmd:`require-fullname`, :mfcmd:`depends-on`, |
| | :mfcmd:`prereq-all` |
| | :mfcmd:`prereq-all`, :mfcmd:`always-load` |
+------------+-----------------------------------------------------------------+
:mfcmd:`system`, :mfcmd:`is-used`

21
doc/source/modulefile.rst
View File

@@ -65,6 +65,27 @@ the Module commands return the empty string. Some commands behave differently
when a *modulefile* is loaded or unloaded. The command descriptions assume
the *modulefile* is being loaded.
.. mfcmd:: always-load [--tag taglist] modulefile...
Load *modulefile* and apply the ``keep-loaded`` tag to it in order to avoid
the automatic unload of this *modulefile* when modules dependent of it are
unloaded.
*modulefile* is declared as a requirement of currently loading module. This
command acts as an alias of :mfcmd:`module load<module>` command. If more
than one *modulefile* are specified, then this list acts as a Boolean AND
operation, which means all specified *modulefiles* are required.
The ``--tag`` option accepts a list of module tags to apply to *modulefile*
once loaded in addition to the ``keep-loaded`` tag. *taglist* corresponds to
the concatenation of multiple tags separated by colon character. *taglist*
should not contain tags inherited from *modulefile* state or from other
modulefile commands.
.. only:: html
.. versionadded:: 5.1
.. mfcmd:: append-path [-d C|--delim C|--delim=C] [--duplicates] variable value...
See :mfcmd:`prepend-path`.