doc: desc. "describe" sub-command

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

Author: xdelaruelle

NEWS.rst

@@ -149,6 +149,7 @@ Modules 5.6.0 (not yet released)
 * Doc: add :ref:`other-implementations` document.
 * Add :subcmd:`update` sub-command, an alias of :subcmd:`reload`
 * Add :subcmd:`disable` sub-command, an alias of :subcmd:`saverm`
+* Add :subcmd:`describe` sub-command, an alias of :subcmd:`saveshow`
 
 .. _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,8 @@ The following module sub-commands appeared on Modules 5.
 +------------+-----------------------------------------------------------------+
 | 5.3        | :subcmd:`cachebuild`, :subcmd:`cacheclear`                      |
 +------------+-----------------------------------------------------------------+
-| 5.6        | :subcmd:`spider`, :subcmd:`update`, :subcmd:`disable`           |
+| 5.6        | :subcmd:`spider`, :subcmd:`update`, :subcmd:`disable`,          |
+|            | :subcmd:`describe`                                              |
 +------------+-----------------------------------------------------------------+
 
 :subcmd:`list`

doc/source/module.rst

@@ -1741,6 +1741,14 @@ Module Sub-Commands
        *Value* prefixes ``+`` and ``-`` added to append and subtract elements
        to list-value options
 
+.. subcmd:: describe [collection]
+
+ See :subcmd:`saveshow`.
+
+ .. only:: html
+
+    .. versionadded:: 5.6
+
 .. subcmd:: disable [collection]
 
  See :subcmd:`saverm`.

doc/source/other-implementations.rst

@@ -90,7 +90,7 @@ at the end of this section to map these equivalents.
 
    * - Lmod 8.8
      - Modules 5.6
-   * - ``category``, ``describe``, ``overview``, ``tablelist``
+   * - ``category``, ``overview``, ``tablelist``
      - :subcmd:`aliases`, :subcmd:`append-path`, :subcmd:`cachebuild`,
        :subcmd:`cacheclear`, :subcmd:`clear`, :subcmd:`config`,
        :subcmd:`edit`, :subcmd:`info-loaded`, :subcmd:`initadd`,
@@ -191,8 +191,6 @@ implementation.
      - ``module config`` :mconfig:`hide_auto_loaded` ``1``
    * - ``module tablelist``
      - ``module list`` :option:`--json`
-   * - ``module describe``
-     - ``module`` :subcmd:`saveshow`
    * - ``module --pin_versions restore``
      - ``module config`` :mconfig:`collection_pin_version` ``1`` +
        ``module save`` + ``module restore``

tcl/report.tcl.in

@@ -2080,7 +2080,7 @@ Collection of modules handling commands:
   save            [collection|file] Save current module list to collection
   restore         [collection|file] Restore module list from collection or file
   saverm | disable     [collection] Remove saved collection
-  saveshow        [collection|file] Display information about collection
+  saveshow | describe   [coll|file] Display information about collection
   savelist  [-a] [-t|-l|-j] [-S|-C] [collection ...]
                                     List all or matching saved collections
   is-saved        [collection ...]  Test if any of the collection(s) exists