Skip to content

Commit 313e70c

Browse files
committed
doc: add correspondence table in other-implementations
Signed-off-by: Xavier Delaruelle <[email protected]>
1 parent 716b4a0 commit 313e70c

File tree

2 files changed

+120
-0
lines changed

2 files changed

+120
-0
lines changed

MIGRATING.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -233,6 +233,8 @@ reserved keyword on this shell.
233233
The Windows-specific distribution zipball of Modules has been updated to also
234234
contain the required files to setup PowerShell support.
235235

236+
.. _Conflict unload MIGRATING:
237+
236238
Conflict unload
237239
---------------
238240

@@ -1274,6 +1276,8 @@ All shells supported by :file:`modulecmd.tcl` script are supported by
12741276
os.environ['FOO'] = 'value'
12751277
os.environ['BAR'] = 'othervalue'
12761278
1279+
.. _Initial environment:
1280+
12771281
Initial environment
12781282
-------------------
12791283

@@ -1531,6 +1535,8 @@ also added to change the output redirection behavior for a single command:
15311535
:ps:`$` module load unknown --no-redirect >/dev/null
15321536
:sgrer:`ERROR`: Unable to locate a modulefile for 'unknown'
15331537
1538+
.. _Change modulefile command behavior:
1539+
15341540
Change modulefile command behavior
15351541
----------------------------------
15361542

doc/source/other-implementations.rst

Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,120 @@ See the :ref:`Compatibility with Lmod Tcl modulefile` section for details on
127127
how the implementation of the Tcl modulefile commands differ between Lmod and
128128
Modules.
129129

130+
The following table provides a correspondence between features in Lmod and
131+
Modules that offer similar functionality, even if they differ in name or
132+
implementation.
133+
134+
.. list-table::
135+
:header-rows: 1
136+
137+
* - Lmod 8.8
138+
- Modules 5.6
139+
* - `Module properties`_
140+
- :ref:`Module tags`
141+
* - `One name rule`_
142+
- :mconfig:`unique_name_loaded` configuration option
143+
* - `Custom labels for avail`_
144+
- :mfcmd:`modulepath-label` modulefile command
145+
* - `Irreversible module actions`_
146+
- :ref:`Change modulefile command behavior`
147+
* - `NAG file`_
148+
- :mfcmd:`module-forbid`, :mfcmd:`module-warn` modulefile commands
149+
* - Lmod + `XALT`_
150+
- :ref:`Logging activity`
151+
* - `Hook functions`_
152+
- :ref:`Override any internal procedures or set trace hook<Site-specific
153+
configuration>`
154+
* - `Autoswap`_
155+
- :ref:`Conflict unload MIGRATING`
156+
* - |LMOD_DOWNSTREAM_CONFLICTS|_ environment variable
157+
- :ref:`Dependencies between modulefiles`
158+
* - |LMOD_QUARANTINE_VARS|_ environment variable
159+
- :mconfig:`protected_envvars` configuration option
160+
* - |clearLmod|_ shell function
161+
- ``module`` :subcmd:`clear`
162+
* - |update_lmod_system_cache_files|_ script
163+
- ``module`` :subcmd:`cachebuild`
164+
* - |sh_to_modulefile|_ script
165+
- ``module`` :subcmd:`sh-to-mod`
166+
* - |check_module_tree_syntax|_ script
167+
- ``module`` :subcmd:`lint`
168+
* - ``module --checkSyntax load``
169+
- ``module`` :subcmd:`lint`
170+
* - ``module --config``
171+
- ``module`` :subcmd:`config`
172+
* - ``module update``
173+
- ``module`` :subcmd:`reload`
174+
* - ``$LMOD_CMD bash load``
175+
- ``module`` :subcmd:`mod-to-sh` ``bash``
176+
* - ``module --raw show``
177+
- ``EDITOR=cat module`` :subcmd:`edit`
178+
* - ``module --location show``
179+
- ``module`` :subcmd:`path`
180+
* - ``module --mt``
181+
- ``module`` :subcmd:`state`
182+
* - ``module overview``
183+
- ``module avail`` :option:`--no-indepth`
184+
* - ``module --regexp avail``
185+
- ``module avail`` :option:`--contains`
186+
* - ``module --show_hidden avail``
187+
- ``module avail`` :option:`--all`
188+
or ``module avail`` :option:`--output` ``+hidden``
189+
* - ``module --style=<style_name> avail``
190+
- ``module avail`` :option:`--output` ``<element_list>``
191+
* - ``module category``
192+
- ``module`` :subcmd:`search`
193+
* - ``module --brief list``
194+
- ``module config`` :mconfig:`hide_auto_loaded` ``1``
195+
* - ``module tablelist``
196+
- ``module list`` :option:`--json`
197+
* - ``module describe``
198+
- ``module`` :subcmd:`saveshow`
199+
* - ``module disable``
200+
- ``module`` :subcmd:`saverm`
201+
* - ``module --pin_versions restore``
202+
- ``module config`` :mconfig:`collection_pin_version` ``1`` +
203+
``module save`` + ``module restore``
204+
* - ``module --initial_load restore``
205+
- ``module restore`` during :ref:`Modules initialization<Initial
206+
environment>`
207+
* - ``atleast("foo","5.0")``
208+
209+
* - ``atmost("foo","5.0")``
210+
- |foo@:5.0|_
211+
* - ``between("foo","5.0","7.0")``
212+
213+
* - ``latest("foo")``
214+
- |foo@latest|_
215+
216+
.. _Irreversible module actions: https://lmod.readthedocs.io/en/latest/370_irreversible.html
217+
.. _NAG file: https://lmod.readthedocs.io/en/latest/140_deprecating_modules.html
218+
.. _Custom labels for avail: https://lmod.readthedocs.io/en/latest/200_avail_custom.html
219+
.. _Module properties: https://lmod.readthedocs.io/en/latest/145_properties.html
220+
.. _One name rule: https://lmod.readthedocs.io/en/latest/010_user.html#users-can-only-have-one-version-active-the-one-name-rule
221+
.. _XALT: https://github.com/xalt/xalt
222+
.. _Autoswap: https://lmod.readthedocs.io/en/latest/060_locating.html#autoswapping-rules
223+
.. |LMOD_DOWNSTREAM_CONFLICTS| replace:: ``LMOD_DOWNSTREAM_CONFLICTS``
224+
.. _LMOD_DOWNSTREAM_CONFLICTS: https://lmod.readthedocs.io/en/latest/090_configuring_lmod.html#configuration-or-cosmic-assign-at-startup
225+
.. |LMOD_QUARANTINE_VARS| replace:: ``LMOD_QUARANTINE_VARS``
226+
.. _LMOD_QUARANTINE_VARS: https://lmod.readthedocs.io/en/latest/090_configuring_lmod.html#environment-variables-only
227+
.. |clearLmod| replace:: ``clearLmod``
228+
.. _clearLmod: https://lmod.readthedocs.io/en/latest/010_user.html#clearlmod-complete-remove-lmod-setup
229+
.. |check_module_tree_syntax| replace:: ``check_module_tree_syntax``
230+
.. _check_module_tree_syntax: https://lmod.readthedocs.io/en/latest/360_check_syntax.html
231+
.. |update_lmod_system_cache_files| replace:: ``update_lmod_system_cache_files``
232+
.. _update_lmod_system_cache_files: https://lmod.readthedocs.io/en/latest/130_spider_cache.html
233+
.. |sh_to_modulefile| replace:: ``sh_to_modulefile``
234+
.. _sh_to_modulefile: https://lmod.readthedocs.io/en/latest/260_sh_to_modulefile.html#converting-shell-scripts-to-modulefiles
235+
236+
.. _[email protected]\:: module.html#version-specifiers
237+
.. |foo@:5.0| replace:: ``foo@:5.0``
238+
.. _foo@\:5.0: module.html#version-specifiers
239+
.. |[email protected]:7.0| replace:: ``[email protected]:7.0``
240+
.. _[email protected]\:7.0: module.html#version-specifiers
241+
.. |foo@latest| replace:: ``foo@latest``
242+
.. _foo@latest: module.html#version-specifiers
243+
130244
Other alternatives
131245
------------------
132246

0 commit comments

Comments
 (0)