doc: desc. __MODULES_LMREFRESH in NEWS/man/changes

Author: xdelaruelle

.aspell.en.pws

@@ -1,4 +1,4 @@
-personal_ws-1.1 en 853
+personal_ws-1.1 en 854
 ABBRVLIST
 ActiveTcl
 Adrien
@@ -89,6 +89,7 @@ LMINIT
 LMNOTUASKED
 LMOD
 LMPREREQ
+LMREFRESH
 LMSOURCESH
 LMTAG
 LMVARIANT

NEWS.rst

@@ -142,6 +142,8 @@ Modules 5.2.0 (not yet released)
   :ref:`log-module-command` recipe. (fix issue #475)
 * Rename the default git branch from *master* to *main* to use inclusive
   terminology.
+* Mark loaded modules that could benefit from a refresh evaluation in the
+  :envvar:`__MODULES_LMREFRESH` environment variable.
 
 .. _Nagelfar: http://nagelfar.sourceforge.net/
 .. _ShellCheck: https://www.shellcheck.net/

doc/source/changes.rst

@@ -892,7 +892,8 @@ The following environment variables appeared on Modules 5.
 | 5.2        | :envvar:`MODULES_PROTECTED_ENVVARS`,                            |
 |            | :envvar:`MODULES_TCL_LINTER`,                                   |
 |            | :envvar:`__MODULES_LMINIT`,                                     |
-|            | :envvar:`MODULES_RESET_TARGET_STATE`                            |
+|            | :envvar:`MODULES_RESET_TARGET_STATE`,                           |
+|            | :envvar:`__MODULES_LMREFRESH`                                   |
 +------------+-----------------------------------------------------------------+
 
 Modules Specific Tcl Commands

doc/source/module.rst

@@ -2716,6 +2716,16 @@ ENVIRONMENT
     .. versionchanged:: 5.0
        Variable renamed from ``MODULES_LMPREREQ`` to ``__MODULES_LMPREREQ``
 
+.. envvar:: __MODULES_LMREFRESH
+
+ A colon separated list of the loaded modules that are qualified for refresh
+ evaluation. Loaded modules listed in this variable are those defining
+ volatile environment changes like shell completion, alias and function.
+
+ .. only:: html
+
+    .. versionadded:: 5.2
+
 .. envvar:: __MODULES_LMSOURCESH
 
  A colon separated list of the :mfcmd:`source-sh` statements defined by all