Skip to content

Commit cf1bb9d

Browse files
committed
doc: fix NEWS placement and cookbook example of purge requirement
Move the NEWS entry to the end of the 5.7.0 list, as entries follow the order changes landed. Report in the cookbook example the output of the env/base load, which auto-loads its requirements, and the auto-loaded tag these requirements then carry in the module list. Also restore the blank line removed from NEWS.rst, unrelated to this change. Assisted-by: Claude:claude-fable-5-1 Signed-off-by: Xavier Delaruelle <xavier.delaruelle@cea.fr>
1 parent ff2ce4c commit cf1bb9d

2 files changed

Lines changed: 8 additions & 5 deletions

File tree

‎NEWS.rst‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -251,9 +251,6 @@ Modules 5.7.0 (not yet released)
251251
* Doc: add the :ref:`user-guide` document that explains a selection of
252252
useful but lesser known features through practical examples and common
253253
use cases.
254-
* Keep non-sticky requirements of sticky modules loaded during a
255-
:subcmd:`purge` and explicitly report why their unload is skipped according
256-
to the :mconfig:`sticky_purge` configuration. (fix issue #582)
257254
* Init: fix command injection in Bash completion when module names contain
258255
shell meta-characters. Completion candidates were passed to ``compgen -W``
259256
which evaluates command substitution syntax. (fix `CVE-2026-85013`_ found
@@ -267,9 +264,13 @@ Modules 5.7.0 (not yet released)
267264
:mfcmd:`is-used` modulefile command or of the :subcmd:`unuse` sub-command
268265
is also resolved against the current working directory to recognize such
269266
entry whatever its form.
267+
* Keep non-sticky requirements of sticky modules loaded during a
268+
:subcmd:`purge` and explicitly report why their unload is skipped according
269+
to the :mconfig:`sticky_purge` configuration. (fix issue #582)
270270

271271
.. _CVE-2026-85013: https://github.com/envmodules/modules/security/advisories/GHSA-8hrw-p88g-qhmg
272272

273+
273274
.. _5.6 release notes:
274275

275276
Modules 5.6.2 (2026-09-07)

‎doc/source/cookbook/sticky-modules.rst‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -200,6 +200,8 @@ module remains loaded:
200200
201201
:ps:`$` module config sticky_purge warning
202202
:ps:`$` module load env/base
203+
Loading :sgrhi:`env/base`
204+
:sgrin:`Loading requirement`: core compiler
203205
:ps:`$` module purge
204206
Unloading :sgrhi:`env/base`
205207
:sgrwa:`WARNING`: Unload of super-sticky module skipped
@@ -211,10 +213,10 @@ module remains loaded:
211213
:sgrwa:`WARNING`: Unload of super-sticky module requirement skipped
212214
:ps:`$` module list
213215
Currently Loaded Modulefiles:
214-
1) core 2) compiler 3) :sgrss:`env/base`
216+
1) :sgral:`core` 2) :sgral:`compiler` 3) :sgrss:`env/base`
215217
216218
Key:
217-
:sgrss:`super-sticky`
219+
:sgral:`auto-loaded` :sgrss:`super-sticky`
218220
219221
Both requirements remain loaded even though they are not sticky themselves.
220222
The same protection applies to indirect requirements and to a forced purge

0 commit comments

Comments
 (0)