doc: fail if sticky module does not reload

Author: xdelaruelle

NEWS.rst

@@ -36,6 +36,9 @@ Modules 5.6.1 (not yet released)
 * Drop tags stored in memory that applies to a module when unloading it. It
   ensures that tags applied to the module when reloaded from a different
   modulepath are not inherited.
+* Always apply *abort on error* behavior in case a Dependent Reload sticky
+  (and :option:`--force` is not set) or super-sticky module fails to reload.
+  (fix issue #601)
 
 .. _Furo: https://github.com/pradyunsg/furo
 

doc/source/design/evaluation-errors.rst

@@ -36,6 +36,10 @@ The following list describes the different kind of evaluation error:
 * *forbidden*: evaluated modulefile is tagged forbidden
 * *sticky unload*: when unloading a module tagged sticky
 * *super-sticky unload*: when unloading a module tagged super-sticky
+* *dependent sticky reload*: *dependent reload* special case where a sticky
+  dependent module fails to reload (during the load phase)
+* *dependent super-sticky reload*: *dependent reload* special case where a
+  super-sticky dependent module fails to reload (during the load phase)
 
 .. note:: Use of ``continue`` Tcl command in modulefile shortens evaluation
    but it is not considered an error.
@@ -123,6 +127,12 @@ configuration options are set to a given value.
 +---------------------+------------+-------------------------------+
 | super-sticky unload | unload     |                               |
 +---------------------+------------+-------------------------------+
+| dependent sticky    | load       |                               |
+| reload              |            |                               |
++---------------------+------------+-------------------------------+
+| dependent           | load       |                               |
+| super-sticky reload |            |                               |
++---------------------+------------+-------------------------------+
 
 When evaluation mode and/or configuration option matches for these error kinds
 to raise, a :ref:`default error behavior<default>` error behavior is applied.
@@ -142,6 +152,7 @@ following errors:
 * conflict
 * missing requirement
 * dependent reload
+* dependent sticky reload
 
 Following behavior is observed:
 
@@ -160,6 +171,12 @@ nonexistent modulefile.
 ``abort_on_error`` configuration option is ignored when ``--force`` option is
 in use. Which means *continue on error* behavior is applied.
 
+*Abort on error* behavior is applied whatever the value of
+:mconfig:`abort_on_error` if following kind of error occurs:
+
+* dependent sticky reload and force mode is disabled.
+* dependent super-sticky reload
+
 Multiple modulefiles passed as argument
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
@@ -299,6 +316,12 @@ force mode is enabled or if reload is removed from :mconfig:`abort_on_error`
 configuration option (where it is enabled by default). In this case, a
 *continue on error* behavior is applied.
 
+*Abort on error* behavior is applied whatever the value of
+:mconfig:`abort_on_error` if:
+
+* a sticky module is not able to reload and force mode is disabled.
+* a super-sticky module is not able to reload
+
 Prior running evaluations, dependencies of loaded modules are checked. If at
 least one dependency (requirement or conflict) is not satisfied, an error is
 raised.
@@ -332,6 +355,7 @@ following errors:
 * dependent reload
 * unloading dependent
 * sticky unload
+* dependent sticky reload
 
 Following behavior is observed:
 
@@ -345,6 +369,12 @@ it from user's loaded environment.
 ``abort_on_error`` configuration option is ignored when ``--force`` option is
 in use. Which means *continue on error* behavior is applied.
 
+*Abort on error* behavior is applied whatever the value of
+:mconfig:`abort_on_error` if following kind of error occurs:
+
+* dependent sticky reload and force mode is disabled.
+* dependent super-sticky reload
+
 Multiple modulefiles passed as argument
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 

doc/source/module.rst

@@ -4537,7 +4537,9 @@ ENVIRONMENT
    available.
 
  However, reload is always attempted if the modulefile is tagged as
- ``super-sticky`` or ``sticky``, and force mode is not enabled. Dependent
+ ``super-sticky`` or ``sticky``, and force mode is not enabled. *Abort on
+ error* behavior is applied if reload of such module kind fails whatever the
+ value of the :mconfig:`abort_on_error` configuration option. Dependent
  Reload modulefiles whose reload has been skipped are treated as Dependent
  Unload modulefiles.
 
@@ -4571,6 +4573,10 @@ ENVIRONMENT
     .. versionchanged:: 5.5
        Reload of all Dependent Reload modules occurs after the main evaluation
 
+    .. versionchanged:: 5.6
+       *Abort on error* behavior is always applied if reload of a Dependent
+       Reload sticky or super-sticky module fails
+
 .. envvar:: MODULES_AVAIL_INDEPTH
 
  If set to ``1``, enable in depth search results for :subcmd:`avail`