From 4c2da53732a52d5af577bf1a4db2dcc8d430db76 Mon Sep 17 00:00:00 2001 From: Xavier Delaruelle Date: Wed, 4 Jun 2025 07:03:09 +0200 Subject: [PATCH] doc: desc. not-found depre reload skip in man/NEWS Signed-off-by: Xavier Delaruelle --- NEWS.rst | 4 ++++ doc/source/module.rst | 18 ++++++++++++------ 2 files changed, 16 insertions(+), 6 deletions(-) diff --git a/NEWS.rst b/NEWS.rst index da960e23..ecca31a0 100644 --- a/NEWS.rst +++ b/NEWS.rst @@ -162,6 +162,10 @@ Modules 5.6.0 (not yet released) * Install: installation option :instopt:`--enable-new-features` is updated to include :instopt:`--enable-require-via`. * Doc: add :ref:`require-via` design notes. +* Skip reload of a *Dependent Reload* module if it is not found after a change + in enabled modulepaths. Reload of a not found module is attempted only if it + is tagged *super-sticky* or *sticky* and force mode is disabled. Skipped + module is considered *Dependent Unload* module. .. _Security policy: https://github.com/envmodules/modules/blob/main/SECURITY.md .. _Modules chat room: https://matrix.to/#/#modules:matrix.org diff --git a/doc/source/module.rst b/doc/source/module.rst index 13f4e88c..9c886bc4 100644 --- a/doc/source/module.rst +++ b/doc/source/module.rst @@ -4500,12 +4500,18 @@ ENVIRONMENT evaluation of the main *modulefile* (either load, unload or switch evaluation). - The reload phase of a Dependent Reload modulefile is skipped either if the - requirements of this modulefile are not loaded or if a conflict is spotted - with the loaded environment. Reload is attempted in any case if modulefile is - tagged ``super-sticky`` or ``sticky`` and force mode is disabled. Dependent - Reload module whose reload has been skipped are considered Dependent Unload - module. + The reload phase of a Dependent Reload modulefile is skipped if any of the + following conditions are met: + + * The required modules for this modulefile are not loaded. + * A conflict is detected with the currently loaded environment. + * The enabled modulepaths have changed, and the modulefile is no longer + available. + + However, reload is always attempted if the modulefile is tagged as + ``super-sticky`` or ``sticky``, and force mode is not enabled. Dependent + Reload modulefiles whose reload has been skipped are treated as Dependent + Unload modulefiles. Conflict Unload mechanism is activated only if :mconfig:`conflict_unload` configuration option is also enabled.