envmodules/modules
1
0
Fork 0
mirror of https://github.com/envmodules/modules.git synced 2026-06-14 00:42:43 +08:00
Code Issues Actions 5 Packages Projects Releases Wiki Activity

doc: desc. always-load in design doc

Browse Source
This commit is contained in:
Xavier Delaruelle
2021-12-19 09:48:33 +01:00
parent 9e5bed7f9a
commit be4c2dbce9
1 changed files with 19 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
doc/source/design/lmod-tcl-modulefile-compat.rst
View File

@@ -136,3 +136,22 @@ Lmod Tcl modulefile compatiblity
- This command is intended for use only within modulefile evaluation context
(not within modulerc)
``always-load``
---------------
- Auto load on or more modules said as dependencies when modulefile is
evaluated in *load* mode
- Semantically this command corresponds to a requirement declaration.
- Make it an alias over :mfcmd:`module load<module>`
- Add ``keep-loaded`` tag to the modules loaded this way
- When several modules are specified, it acts as an *AND* operation, which
means all specified modules are required
- When modulefile is unloaded, the *always-load* modules are not automatically
unloaded as they own the ``keep-loaded`` tag
- This command is intended for use only within modulefile evaluation context
(not within modulerc)