doc: desc. indesym avail output element

Author: xdelaruelle

INSTALL.rst

@@ -718,8 +718,8 @@ instance :instopt:`--without-modulepath<--with-modulepath>`):
 
  Specify the content to report on avail sub-command regular output in addition
  to the available module names. Elements accepted in LIST are: ``modulepath``,
- ``alias``, ``dirwsym``, ``sym``, ``tag``, ``key``, ``variant`` and
- ``variantifspec`` (elements in LIST are separated by ``:``). The order of
+ ``alias``, ``dirwsym``, ``indesym``, ``sym``, ``tag``, ``key``, ``variant``
+ and ``variantifspec`` (elements in LIST are separated by ``:``). The order of
  the elements in LIST does not matter.
  (default=\ ``modulepath:alias:dirwsym:sym:tag:variantifspec:key``)
 
@@ -737,13 +737,16 @@ instance :instopt:`--without-modulepath<--with-modulepath>`):
     .. versionchanged:: 5.3
        Element ``variantifspec`` added and set by default
 
+    .. versionchanged:: 5.3.1
+       Element ``indesym`` added
+
 .. instopt:: --with-avail-terse-output=LIST
 
  Specify the content to report on avail sub-command terse output in addition
  addition to the available module names. Elements accepted in LIST are:
- ``modulepath``, ``alias``, ``dirwsym``, ``sym``, ``tag``, ``key``,
- ``variant`` and ``variantifspec`` (elements in LIST are separated by ``:``).
- The order of the elements in LIST does not matter.
+ ``modulepath``, ``alias``, ``dirwsym``, ``indesym``, ``sym``, ``tag``,
+ ``key``, ``variant`` and ``variantifspec`` (elements in LIST are separated by
+ ``:``). The order of the elements in LIST does not matter.
  (default=\ ``modulepath:alias:dirwsym:sym:tag:variantifspec``)
 
  This installation option defines the default value of the
@@ -760,6 +763,9 @@ instance :instopt:`--without-modulepath<--with-modulepath>`):
     .. versionchanged:: 5.3
        Element ``variantifspec`` added and set by default
 
+    .. versionchanged:: 5.3.1
+       Element ``indesym`` added
+
 .. instopt:: --with-bashcompletiondir=DIR
 
  Directory for Bash completion scripts. When this option is not set Bash

NEWS.rst

@@ -33,6 +33,10 @@ Modules 5.3.1 (not yet released)
   (:subcmd:`avail`, :subcmd:`paths` or :subcmd:`whatis` sub-commands),
   available modules returned are those providing all variant values set. (fix
   issue #499)
+* Add the ``indesym`` element in the allowed value list of the
+  :mconfig:`avail_output` and :mconfig:`avail_terse_output` configuration
+  options. When set, symbolic versions are reported as independent elements
+  rather along the module or directory they are attached to.
 
 .. _Hunspell: https://hunspell.github.io/
 

doc/source/changes.rst

@@ -1076,6 +1076,9 @@ The following Modules configuration option has been introduced on Modules 5.
  ``+`` or ``-`` which means value should respectively be appended to or
  subtracted from current configuration option value.
 
+ Starting version 5.3.1, element ``indesym`` is added to the list of accepted
+ values.
+
 :mconfig:`list_output`, :mconfig:`list_terse_output`, :mconfig:`colors`,
 :mconfig:`protected_envvars`, :mconfig:`shells_with_ksh_fpath`,
 :mconfig:`tag_abbrev`, :mconfig:`tag_color_name`, :mconfig:`variant_shortcut`

doc/source/design/output-configuration.rst

@@ -53,8 +53,8 @@ Specification
 
 - Accepted elements in value lists are:
 
-  - For ``avail`` options: modulepath, alias, dirwsym, sym, tag, key, variant,
-    variantifspec
+  - For ``avail`` options: modulepath, alias, dirwsym, indesym, sym, tag, key,
+    variant, variantifspec
   - For ``list`` options: header, idx, variant, sym, tag, key
 
 - If the ``-o``/``--output`` options are wrongly specified

doc/source/module.rst

@@ -401,8 +401,8 @@ switches are accepted:
  does not matter.
 
  Accepted elements in *LIST* for :subcmd:`avail` sub-command are:
- *modulepath*, *alias*, *dirwsym*, *sym*, *tag*, *key*, *variant* and
- *variantifspec*.
+ *modulepath*, *alias*, *dirwsym*, *indesym*, *sym*, *tag*, *key*, *variant*
+ and *variantifspec*.
 
  Accepted elements in *LIST* for :subcmd:`list` sub-command are: *header*,
  *idx*, *variant*, *sym*, *tag* and *key*.
@@ -429,6 +429,9 @@ switches are accepted:
     .. versionchanged:: 5.3
        Prefixes ``+`` and ``-`` added to append and subtract elements
 
+    .. versionchanged:: 5.3.1
+       Element *indesym* added for :subcmd:`avail` sub-command
+
 .. option:: --paginate
 
  Pipe all message output into :command:`less` (or if set, to the command
@@ -3765,6 +3768,8 @@ ENVIRONMENT
 
  * ``alias``: module aliases.
  * ``dirwsym``: directories associated with symbolic versions.
+ * ``indesym``: symbolic versions reported independently from the module or
+   directory they are attached to.
  * ``key``: legend appended at the end of the output to explain it.
  * ``modulepath``: modulepath names set as header prior the list of available
    modules found in them.
@@ -3782,6 +3787,9 @@ ENVIRONMENT
  modules from global/user rc and all enabled modulepaths are reported as a
  single list.
 
+ When ``indesym`` element is set, ``dirwsym`` and ``sym`` elements are
+ disabled.
+
  This environment variable value supersedes the default value set in the
  :mconfig:`avail_output` configuration option. It can be defined with
  the :subcmd:`config` sub-command. The :option:`--output`/:option:`-o` command
@@ -3794,6 +3802,9 @@ ENVIRONMENT
     .. versionchanged:: 5.3
        Elements ``variant`` and ``variantifspec`` added
 
+    .. versionchanged:: 5.3.1
+       Element ``indesym`` added
+
 .. envvar:: MODULES_AVAIL_TERSE_OUTPUT
 
  A colon separated list of the elements to report in addition to module names