Skip to content

Commit 3d02018

Browse files
committed
doc: link to --tag option section
1 parent f93eed4 commit 3d02018

File tree

3 files changed

+16
-15
lines changed

3 files changed

+16
-15
lines changed

NEWS.rst

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -190,25 +190,25 @@ Modules 5.1.0 (not yet released)
190190
ability to catch this content.
191191
* Lib: handle ``sysconf`` error in function implementing the
192192
``initStateUsergroups`` procedure. (contribution from Lukáš Zaoral)
193-
* Introduce the ``--tag`` option for the :subcmd:`load`, :subcmd:`try-load`,
194-
:subcmd:`load-any`, :subcmd:`switch` sub-commands and associated
195-
:mfcmd:`module` modulefile commands and :mfcmd:`prereq`, mfcmd:`prereq-all`,
196-
:mfcmd:`depends-on` and :mfcmd:`always-load` modulefile commands. This new
197-
option applies specified tags to the module to load.
198-
* Record tags set to loaded modules with the ``--tag`` option in the
193+
* Introduce the :option:`--tag` option for the :subcmd:`load`,
194+
:subcmd:`try-load`, :subcmd:`load-any`, :subcmd:`switch` sub-commands and
195+
associated :mfcmd:`module` modulefile commands and :mfcmd:`prereq`,
196+
mfcmd:`prereq-all`, :mfcmd:`depends-on` and :mfcmd:`always-load` modulefile
197+
commands. This new option applies specified tags to the module to load.
198+
* Record tags set to loaded modules with the :option:`--tag` option in the
199199
:envvar:`__MODULES_LMEXTRATAG` environment variable to make this information
200200
persists after module being loaded.
201-
* When saving a collection, record loaded module tags set with the ``--tag``
202-
option and those resulting from module load states (like ``auto-loaded`` and
203-
``keep-loaded``). The ``--notuasked`` string previously used to designate
204-
auto-loaded modules in collection is changed into the ``--tag=auto-loaded``
205-
option.
201+
* When saving a collection, record loaded module tags set with the
202+
:option:`--tag` option and those resulting from module load states (like
203+
``auto-loaded`` and ``keep-loaded``). The ``--notuasked`` string previously
204+
used to designate auto-loaded modules in collection is changed into the
205+
``--tag=auto-loaded`` option.
206206
* Introduce the :mconfig:`collection_pin_tag` configuration option, that
207207
records in collection all tags set on loaded modules when enabled. Option is
208208
disabled by default and when set it defines the :envvar:`MODULES_COLLECTION\
209209
_PIN_TAG` environment variable.
210210
* When a collection is saved, its content starts with a ``#%Module5.1`` file
211-
signature if ``--tag`` option is recorded in it.
211+
signature if :option:`--tag` option is recorded in it.
212212
* Update the :subcmd:`restore`, :subcmd:`savelist`, :subcmd:`saveshow` and
213213
:subcmd:`is-saved` sub-commands to exclude from result or return an error
214214
when checking a collection expressing a higher Modules version requirement

doc/source/changes.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -828,7 +828,7 @@ The following command line switches appeared on Modules 5.
828828
| Introduced | New command line switches |
829829
| in version | |
830830
+============+=================================================================+
831-
| 5.1 | :option:`--redirect`, :option:`--no-redirect` |
831+
| 5.1 | :option:`--redirect`, :option:`--no-redirect`, :option:`--tag` |
832832
+------------+-----------------------------------------------------------------+
833833

834834
Module Sub-Commands
@@ -902,7 +902,8 @@ The following modulefile Tcl commands appeared on Modules 5.
902902

903903
:mfcmd:`prereq`, :mfcmd:`module load/try-load/load-any/switch<module>`
904904

905-
Starting Modules 5.1, these modulefile commands accept the ``--tag`` option.
905+
Starting Modules 5.1, these modulefile commands accept the :option:`--tag`
906+
option.
906907

907908
:mfcmd:`module try-load/load-any<module>`
908909

doc/source/design/module-tags.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Specification
1919

2020
- For instance, a module with a ``sticky`` tag set on it cannot be unloaded
2121

22-
- Tag may also be set manually with the ``--tag`` sub-command option
22+
- Tag may also be set manually with the :option:`--tag` sub-command option
2323

2424
- Applies to :subcmd:`load`, :subcmd:`try-load`, :subcmd:`load-any` and :subcmd:`switch` sub-commands
2525
- When directly used from the terminal session or within modulefile

0 commit comments

Comments
 (0)