Skip to content

Commit 8eec2bd

Browse files
committed
doc: add an option section for --tag in module(1)
1 parent 52c1319 commit 8eec2bd

File tree

1 file changed

+25
-13
lines changed

1 file changed

+25
-13
lines changed

doc/source/module.rst

Lines changed: 25 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -421,6 +421,18 @@ switches are accepted:
421421
.. versionchanged:: 5.1
422422
Support for :subcmd:`list` sub-command added
423423

424+
.. option:: --tag=LIST
425+
426+
On :subcmd:`load`, :subcmd:`load-any`, :subcmd:`switch` and
427+
:subcmd:`try-load` sub-commands, apply LIST of module tags to the loading
428+
*modulefile*. *LIST* corresponds to the concatenation of multiple tags
429+
separated by colon character (``:``). *LIST* should not contain tags
430+
inherited from *modulefile* state or from other modulefile commands.
431+
432+
.. only:: html
433+
434+
.. versionadded:: 5.1
435+
424436
.. option:: --terse, -t
425437

426438
Display :subcmd:`avail`, :subcmd:`list` and :subcmd:`savelist` output in
@@ -1439,7 +1451,7 @@ Module Sub-Commands
14391451
:option:`--force`/:option:`-f` added
14401452

14411453
.. versionchanged:: 5.1
1442-
Option ``--tag`` added
1454+
Option :option:`--tag` added
14431455

14441456

14451457
.. subcmd:: load-any [options] modulefile...
@@ -1630,8 +1642,8 @@ Module Sub-Commands
16301642
:envvar:`MODULES_COLLECTION_PIN_VERSION` is set to ``1``, module version is
16311643
always recorded even if it is the default version.
16321644

1633-
By default, only the module tags specifically set with the ``--tag`` option
1634-
or resulting from a specific module state (like ``auto-loaded`` and
1645+
By default, only the module tags specifically set with the :option:`--tag`
1646+
option or resulting from a specific module state (like ``auto-loaded`` and
16351647
``keep-loaded`` tags) are recorded in collection. If
16361648
:envvar:`MODULES_COLLECTION_PIN_TAG` is set to ``1``, all tags are recorded
16371649
in collection except ``nearly-forbidden`` tag.
@@ -1786,7 +1798,7 @@ Module Sub-Commands
17861798
:option:`--force`/:option:`-f` added
17871799

17881800
.. versionchanged:: 5.1
1789-
Option ``--tag`` added
1801+
Option :option:`--tag` added
17901802

17911803
.. subcmd:: test modulefile...
17921804

@@ -1839,7 +1851,7 @@ Module Sub-Commands
18391851
.. versionadded:: 4.8
18401852

18411853
.. versionchanged:: 5.1
1842-
Option ``--tag`` added
1854+
Option :option:`--tag` added
18431855

18441856
.. subcmd:: unload [--auto|--no-auto] [-f] modulefile...
18451857

@@ -2381,14 +2393,14 @@ ENVIRONMENT
23812393
.. envvar:: __MODULES_LMEXTRATAG
23822394

23832395
A colon separated list of the tags corresponding to all loaded *modulefiles*
2384-
that have been set through the ``--tag`` option. Each element in this list
2385-
starts by the name of the loaded *modulefile* followed by all explicitly set
2386-
tags applying to it. The loaded modulefile and its tags are separated by the
2387-
ampersand character.
2396+
that have been set through the :option:`--tag` option. Each element in this
2397+
list starts by the name of the loaded *modulefile* followed by all explicitly
2398+
set tags applying to it. The loaded modulefile and its tags are separated by
2399+
the ampersand character.
23882400

23892401
This environment variable is intended for :command:`module` command internal
23902402
use to distinguish from all tags those that have been specifically set with
2391-
``--tag`` option.
2403+
:option:`--tag` option.
23922404

23932405
.. only:: html
23942406

@@ -2740,9 +2752,9 @@ ENVIRONMENT
27402752
.. envvar:: MODULES_COLLECTION_PIN_TAG
27412753

27422754
If set to ``1``, register all tags applying to modulefiles when saving a
2743-
collection. Otherwise only the extra tags set through the ``--tag`` option
2744-
and tags resulting from specific module states (like ``auto-loaded`` and
2745-
``keep-loaded`` tags) are recorded in collection. Note that the
2755+
collection. Otherwise only the extra tags set through the :option:`--tag`
2756+
option and tags resulting from specific module states (like ``auto-loaded``
2757+
and ``keep-loaded`` tags) are recorded in collection. Note that the
27462758
``nearly-forbidden`` tag due to its temporal meaning is not saved in
27472759
collection even when this configuration option is enabled.
27482760

0 commit comments

Comments
 (0)