Skip to content

Commit 50fb319

Browse files
committed
doc: desc. tags improvement in NEWS/MIGRATING
1 parent 30609bb commit 50fb319

File tree

2 files changed

+38
-0
lines changed

2 files changed

+38
-0
lines changed

MIGRATING.rst

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -225,6 +225,41 @@ Note that when processing a :mfcmd:`family` command, the
225225
:envvar:`LMOD_FAMILY_\<NAME\>` environment variable is defined by Modules to
226226
be compatible with existing modulefiles or scripts relying on such variable.
227227

228+
More tagging capabilities
229+
-------------------------
230+
231+
The new :option:`--tag` option helps to define extra tags onto a loading
232+
module. These tags comes in addition to those inherited from the module state
233+
or those associated with the :mfcmd:`module-tag` modulefile command.
234+
235+
The :option:`--tag` option is available on :subcmd:`load`, :subcmd:`load-any`,
236+
:subcmd:`switch` and :subcmd:`try-load` sub-commands and on
237+
:mfcmd:`always-load`, :mfcmd:`depends-on`, :mfcmd:`module`, :mfcmd:`prereq`,
238+
:mfcmd:`prereq-all` and :mfcmd:`prereq-any` modulefile commands.
239+
240+
In case the designated module is already loaded, the additional tags are added
241+
to the list of tags already applied to this module.
242+
243+
The ``keep-loaded`` tag is introduced in this version. It avoids an
244+
auto-loaded module to get automatically unloaded when its dependent modules
245+
are unloaded. This new tag can be set with the :mfcmd:`module-tag` modulefile
246+
command or when module is loaded with the :mfcmd:`always-load` modulefile
247+
command. Default :mconfig:`tag_abbrev` configuration option has been updated
248+
to add the ``kL`` abbreviation for ``keep-loaded`` tag. Default dark and light
249+
color palettes have been updated too.
250+
251+
When saving a collection, the tags defined with :option:`--tag` option are
252+
recorded to set them again when collection is restored. Tags resulting from
253+
module load state, like ``auto-loaded`` and ``keep-loaded``, are also
254+
recorded.
255+
256+
The :mconfig:`collection_pin_tag` configuration option is added to record in
257+
collection all tags set on loaded modules. This configuration option is
258+
disabled by default.
259+
260+
.. note:: Collection saved now starts with a ``#%Module5.1`` file signature if
261+
:option:`--tag` option is recorded in it. Such collection could only be
262+
handled by Modules version 5.1 and above.
228263

229264
v5.0
230265
====

NEWS.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -218,6 +218,9 @@ Modules 5.1.0 (not yet released)
218218
:ref:`modulefile(4)` man page.
219219
* Doc: describe :mfcmd:`module` sub-commands available as modulefile Tcl
220220
command for each interpretation context in :ref:`modulefile(4)` man page.
221+
* When loading a module with some extra tags defined through the
222+
:option:`--tag` option, if this module is already loaded the new tags are
223+
added to those already set.
221224

222225
.. _Code of conduct: https://github.com/cea-hpc/modules/blob/master/CODE_OF_CONDUCT.md
223226
.. _codespell: https://github.com/codespell-project/codespell

0 commit comments

Comments
 (0)