Skip to content

Commit bb5ec41

Browse files
committed
doc: add examples in more tagging section in MIGRATING
1 parent 8df7fba commit bb5ec41

File tree

4 files changed

+67
-2
lines changed

4 files changed

+67
-2
lines changed

.aspell.en.pws

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
personal_ws-1.1 en 798
1+
personal_ws-1.1 en 800
22
ABBRVLIST
33
ActiveTcl
44
Adrien
@@ -648,12 +648,14 @@ sgrf
648648
sgrh
649649
sgrhi
650650
sgrin
651+
sgrkl
651652
sgrl
652653
sgrme
653654
sgrmp
654655
sgrnf
655656
sgrs
656657
sgrse
658+
sgrshi
657659
sgrss
658660
sgrsy
659661
sgrtr

MIGRATING.rst

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -237,9 +237,26 @@ The :option:`--tag` option is available on :subcmd:`load`, :subcmd:`load-any`,
237237
:mfcmd:`always-load`, :mfcmd:`depends-on`, :mfcmd:`module`, :mfcmd:`prereq`,
238238
:mfcmd:`prereq-all` and :mfcmd:`prereq-any` modulefile commands.
239239

240+
Informational messages of module evaluation have been updated to mention in
241+
module denomination the tags applying to it, as it is done in :subcmd:`list`
242+
sub-command output:
243+
244+
.. parsed-literal::
245+
246+
:ps:`$` module load -v --tag=sticky:bar foo/1.0
247+
Loading :sgrshi:`foo/1.0` <bar>
248+
240249
In case the designated module is already loaded, the additional tags are added
241250
to the list of tags already applied to this module.
242251

252+
.. parsed-literal::
253+
254+
:ps:`$` module list
255+
Currently Loaded Modulefiles:
256+
1) foo/1.0
257+
:ps:`$` module load -v --tag=sticky:bar foo/1.0
258+
Tagging :sgrshi:`foo/1.0` <bar>
259+
243260
The ``keep-loaded`` tag is introduced in this version. It avoids an
244261
auto-loaded module to get automatically unloaded when its dependent modules
245262
are unloaded. This new tag can be set with the :mfcmd:`module-tag` modulefile
@@ -248,11 +265,46 @@ command. Default :mconfig:`tag_abbrev` configuration option has been updated
248265
to add the ``kL`` abbreviation for ``keep-loaded`` tag. Default dark and light
249266
color palettes have been updated too.
250267

268+
.. parsed-literal::
269+
270+
:ps:`$` module show bar/1.0
271+
-------------------------------------------------------------------
272+
:sgrhi:`/path/to/modulefiles/bar/1.0`:
273+
274+
:sgrcm:`always-load` foo/1.0
275+
-------------------------------------------------------------------
276+
:ps:`$` module load bar/1.0
277+
Loading :sgrhi:`bar/1.0`
278+
:sgrin:`Loading requirement`: foo/1.0
279+
:ps:`$` module unload bar/1.0
280+
:ps:`$` module list
281+
Currently Loaded Modulefiles:
282+
1) :sgral:`foo`:sgrkl:`/1.0`
283+
284+
Key:
285+
:sgral:`auto-loaded` :sgrkl:`keep-loaded`
286+
251287
When saving a collection, the tags defined with :option:`--tag` option are
252288
recorded to set them again when collection is restored. Tags resulting from
253289
module load state, like ``auto-loaded`` and ``keep-loaded``, are also
254290
recorded.
255291

292+
.. parsed-literal::
293+
294+
:ps:`$` module load --tag=sticky bar/1.0
295+
Loading :sgrshi:`bar/1.0`
296+
:sgrin:`Loading requirement`: foo/1.0
297+
:ps:`$` module save
298+
:ps:`$` module saveshow
299+
-------------------------------------------------------------------
300+
:sgrhi:`/home/user/.module/default`:
301+
302+
:sgrcm:`module` use --append /path/to/modulefiles
303+
:sgrcm:`module` load --tag=auto-loaded:keep-loaded foo
304+
:sgrcm:`module` load --tag=sticky bar
305+
306+
-------------------------------------------------------------------
307+
256308
The :mconfig:`collection_pin_tag` configuration option is added to record in
257309
collection all tags set on loaded modules. This configuration option is
258310
disabled by default.

doc/source/_static/terminal_output.css

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,15 @@
9898
background-color: #06989a;
9999
}
100100

101+
.sgrshi {
102+
background-color: #06989a;
103+
font-weight: bold;
104+
}
105+
101106
.sgrss {
102107
background-color: #3465a4;
103108
}
109+
110+
.sgrkl {
111+
background-color: #688f8f;
112+
}

doc/source/conf.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -285,7 +285,9 @@ def get_version_release_from_git():
285285
.. role:: sgrf
286286
.. role:: sgrnf
287287
.. role:: sgrs
288-
.. role:: sgrss"""
288+
.. role:: sgrshi
289+
.. role:: sgrss
290+
.. role:: sgrkl"""
289291

290292

291293
# -- Options for manual page output ---------------------------------------

0 commit comments

Comments
 (0)