Skip to content

Commit 716b4a0

Browse files
committed
doc: improve feature diff in other-implementations
Signed-off-by: Xavier Delaruelle <[email protected]>
1 parent bff1930 commit 716b4a0

File tree

3 files changed

+22
-8
lines changed

3 files changed

+22
-8
lines changed

.hunspell.en.dic

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1237,3 +1237,4 @@ Mii
12371237
RenvModule
12381238
tablelist
12391239
haveDynamicMPATH
1240+
settarg

doc/source/module.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -478,6 +478,8 @@ switches are accepted:
478478

479479
.. versionadded:: 5.1
480480

481+
.. _--output:
482+
481483
.. option:: --output=LIST, -o LIST
482484

483485
Define the content to report in addition to module names. This option is
@@ -4388,6 +4390,8 @@ ENVIRONMENT
43884390

43894391
.. versionadded:: 4.4
43904392

4393+
.. _MODULES_AUTO_HANDLING:
4394+
43914395
.. envvar:: MODULES_AUTO_HANDLING
43924396

43934397
If set to ``1``, enable automated module handling mode. If set to ``0``

doc/source/other-implementations.rst

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -33,17 +33,21 @@ table highlights features that are unique to each implementation.
3333
.. list-table::
3434
:header-rows: 1
3535

36-
* - Lmod ``8.8``
37-
- Modules ``5.6``
36+
* - Lmod 8.8
37+
- Modules 5.6
3838
* - * Integration with *rc* shell and *json* structured output
3939
* `Lua modulefile support`_
4040
* `Module hierarchy`_
4141
* Save configuration under :envvar:`XDG_CONFIG_HOME`
4242
* `i18n`_
4343
* `Find best module`_
4444
* `Path entry priorities`_
45+
* ``--regexp`` search option
46+
* `settarg`_
47+
* `Hook functions`_
48+
* |LMOD_FILE_IGNORE_PATTERNS|_ environment variable
4549
- * Integration with *cmd* and *pwsh* shells and *Tcl* language
46-
* :envvar:`Automated module handling<MODULES_AUTO_HANDLING>`
50+
* :ref:`Automated module handling<MODULES_AUTO_HANDLING>`
4751
* :ref:`Advanced module version specifiers`
4852
* :ref:`Module variants`
4953
* :ref:`Virtual modules`
@@ -55,7 +59,7 @@ table highlights features that are unique to each implementation.
5559
* ``alias``, ``command``, ``loaded``, ``tags``, ``usergroups`` and
5660
``username`` sub-commands of :mfcmd:`module-info`
5761
* :ref:`Super-sticky modules<Sticky modules>`
58-
* :option:`Fine-tuned output configuration<--output>`
62+
* :ref:`Fine-tuned output configuration<--output>`
5963
* :ref:`Editing modulefiles`
6064
* :ref:`Tag when loading module<More tagging capabilities>`
6165
* :ref:`Stashing environment`
@@ -64,12 +68,17 @@ table highlights features that are unique to each implementation.
6468
* Integration with *bash-eval* and *fish* shells in :mfcmd:`source-sh`
6569
* :ref:`Specific modulepath for requirements`
6670
* :ref:`Logging activity`
71+
* :command:`envml` launcher
6772

6873
.. _Module hierarchy: https://lmod.readthedocs.io/en/latest/080_hierarchy.html
6974
.. _Lua modulefile support: https://lmod.readthedocs.io/en/latest/050_lua_modulefiles.html
7075
.. _Find best module: https://lmod.readthedocs.io/en/latest/060_locating.html
7176
.. _i18n: https://lmod.readthedocs.io/en/latest/185_localization.html
7277
.. _Path entry priorities: https://lmod.readthedocs.io/en/latest/077_ref_counting.html#specifying-priorities-for-path-entries
78+
.. _settarg: https://lmod.readthedocs.io/en/latest/310_settarg.html
79+
.. _Hook functions: https://lmod.readthedocs.io/en/latest/170_hooks.html#hook-functions
80+
.. |LMOD_FILE_IGNORE_PATTERNS| replace:: ``LMOD_FILE_IGNORE_PATTERNS``
81+
.. _LMOD_FILE_IGNORE_PATTERNS: https://lmod.readthedocs.io/en/latest/090_configuring_lmod.html#setting-environment-variables-or-cosmic-assign-at-startup
7382

7483
The following table highlights ``module`` sub-commands that are exclusive to
7584
either Lmod or Modules. In some cases, similar functionality exists under
@@ -79,8 +88,8 @@ at the end of this section to map these equivalents.
7988
.. list-table::
8089
:header-rows: 1
8190

82-
* - Lmod ``8.8``
83-
- Modules ``5.6``
91+
* - Lmod 8.8
92+
- Modules 5.6
8493
* - ``category``, ``describe``, ``disable``, ``overview``, ``tablelist``,
8594
``update``
8695
- :subcmd:`aliases`, :subcmd:`append-path`, :subcmd:`cachebuild`,
@@ -104,8 +113,8 @@ the end of this section to map these equivalents.
104113
.. list-table::
105114
:header-rows: 1
106115

107-
* - Lmod ``8.8``
108-
- Modules ``5.6``
116+
* - Lmod 8.8
117+
- Modules 5.6
109118
* - ``extensions``, ``haveDynamicMPATH``, ``remove-property``
110119
- :mfcmd:`getvariant`, :mfcmd:`is-saved`, :mfcmd:`is-used`,
111120
:mfcmd:`lsb-release`, :mfcmd:`module-help`, :mfcmd:`module-tag`,

0 commit comments

Comments
 (0)