doc: desc. "update" sub-command

Signed-off-by: Xavier Delaruelle <[email protected]>

Author: xdelaruelle

NEWS.rst

@@ -147,6 +147,7 @@ Modules 5.6.0 (not yet released)
 * Doc: improve :ref:`enable-modules-in-shells` guidelines.
 * Doc: add :ref:`man-path` cookbook recipe.
 * Doc: add :ref:`other-implementations` document.
+* Add :subcmd:`update` sub-command, an alias of :subcmd:`reload`
 
 .. _Security policy: https://github.com/envmodules/modules/blob/main/SECURITY.md
 .. _Modules chat room: https://matrix.to/#/#modules:matrix.org

doc/source/changes.rst

@@ -903,7 +903,7 @@ The following module sub-commands appeared on Modules 5.
 +------------+-----------------------------------------------------------------+
 | 5.3        | :subcmd:`cachebuild`, :subcmd:`cacheclear`                      |
 +------------+-----------------------------------------------------------------+
-| 5.6        | :subcmd:`spider`                                                |
+| 5.6        | :subcmd:`spider`, :subcmd:`update`                              |
 +------------+-----------------------------------------------------------------+
 
 :subcmd:`list`

doc/source/module.rst

@@ -2892,6 +2892,14 @@ Module Sub-Commands
     .. versionchanged:: 5.0
        Accept several modulepaths passed as a single string
 
+.. subcmd:: update [-f]
+
+ See :subcmd:`reload`.
+
+ .. only:: html
+
+    .. versionadded:: 5.6
+
 .. subcmd:: use [-a|--append] directory...
 
  Prepend one or more *directories* to the :envvar:`MODULEPATH` environment

doc/source/other-implementations.rst

@@ -90,8 +90,7 @@ at the end of this section to map these equivalents.
 
    * - Lmod 8.8
      - Modules 5.6
-   * - ``category``, ``describe``, ``disable``, ``overview``, ``tablelist``,
-       ``update``
+   * - ``category``, ``describe``, ``disable``, ``overview``, ``tablelist``
      - :subcmd:`aliases`, :subcmd:`append-path`, :subcmd:`cachebuild`,
        :subcmd:`cacheclear`, :subcmd:`clear`, :subcmd:`config`,
        :subcmd:`edit`, :subcmd:`info-loaded`, :subcmd:`initadd`,
@@ -169,8 +168,6 @@ implementation.
      - ``module`` :subcmd:`lint`
    * - ``module --config``
      - ``module`` :subcmd:`config`
-   * - ``module update``
-     - ``module`` :subcmd:`reload`
    * - ``$LMOD_CMD bash load``
      - ``module`` :subcmd:`mod-to-sh` ``bash``
    * - ``module --raw show`` 

tcl/report.tcl.in

@@ -2055,7 +2055,7 @@ Loading / Unloading commands:
   add-any | load-any modfile [...]  Load first available modulefile in list
   rm | unload     modulefile [...]  Remove modulefile(s)
   purge                             Unload all loaded modulefiles
-  reload                            Unload then load all loaded modulefiles
+  reload | update                   Unload then load all loaded modulefiles
   switch | swap   [mod1] mod2       Unload mod1 and load mod2
   refresh                           Refresh loaded module volatile components
   reset                             Restore initial environment