install/doc: desc. provided-alias addition to {avail,spider}_output

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

Author: xdelaruelle

INSTALL.rst

@@ -943,10 +943,10 @@ 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``, ``indesym``, ``sym``, ``tag``, ``key``, ``hidden``,
- ``variant``, ``variantifspec`` and ``via`` (elements in LIST are separated by
- ``:``). The order of the elements in LIST does not matter.
- (default=\ ``modulepath:alias:dirwsym:sym:tag:variantifspec:key``)
+ ``alias``, ``provided-alias``, ``dirwsym``, ``indesym``, ``sym``, ``tag``,
+ ``key``, ``hidden``, ``variant``, ``variantifspec`` and ``via`` (elements in
+ LIST are separated by ``:``). The order of the elements in LIST does not
+ matter. (default=\ ``modulepath:alias:dirwsym:sym:tag:variantifspec:key``)
 
  This installation option defines the default value of the
  :mconfig:`avail_output` configuration option which could be changed after
@@ -966,15 +966,16 @@ instance :instopt:`--without-modulepath<--with-modulepath>`):
        Element ``indesym`` added
 
     .. versionchanged:: 5.6
-       Elements ``hidden`` and ``via`` added
+       Elements ``hidden``, ``provided-alias`` and ``via`` 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``, ``indesym``, ``sym``, ``tag``,
- ``key``, ``hidden``, ``variant`` and ``variantifspec`` (elements in LIST are
- separated by ``:``). The order of the elements in LIST does not matter.
+ ``modulepath``, ``alias``, ``provided-alias``, ``dirwsym``, ``indesym``,
+ ``sym``, ``tag``, ``key``, ``hidden``, ``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
@@ -995,7 +996,7 @@ instance :instopt:`--without-modulepath<--with-modulepath>`):
        Element ``indesym`` added
 
     .. versionchanged:: 5.6
-       Element ``hidden`` added
+       Elements ``hidden`` and ``provided-alias`` added
 
 .. instopt:: --with-bashcompletiondir=DIR
 
@@ -1398,10 +1399,10 @@ instance :instopt:`--without-modulepath<--with-modulepath>`):
 
  Specify the content to report on spider sub-command regular output in
  addition to the available module names. Elements accepted in LIST are:
- ``modulepath``, ``alias``, ``dirwsym``, ``indesym``, ``sym``, ``tag``,
- ``key``, ``hidden``, ``variant``, ``variantifspec`` and ``via`` (elements in
- LIST are separated by ``:``). The order of the elements in LIST does not
- matter.
+ ``modulepath``, ``alias``, ``provided-alias``, ``dirwsym``, ``indesym``,
+ ``sym``, ``tag``, ``key``, ``hidden``, ``variant``, ``variantifspec`` and
+ ``via`` (elements in LIST are separated by ``:``). The order of the elements
+ in LIST does not matter.
  (default=\ ``modulepath:alias:dirwsym:sym:tag:variantifspec:via:key``)
 
  This installation option defines the default value of the
@@ -1416,9 +1417,10 @@ instance :instopt:`--without-modulepath<--with-modulepath>`):
 
  Specify the content to report on spider sub-command terse output in addition
  addition to the available module names. Elements accepted in LIST are:
- ``modulepath``, ``alias``, ``dirwsym``, ``indesym``, ``sym``, ``tag``,
- ``key``, ``hidden``, ``variant`` and ``variantifspec`` (elements in LIST are
- separated by ``:``). The order of the elements in LIST does not matter.
+ ``modulepath``, ``alias``, ``provided-alias``, ``dirwsym``, ``indesym``,
+ ``sym``, ``tag``, ``key``, ``hidden``, ``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

configure

@@ -432,17 +432,19 @@ Optional Packages:
   --with-avail-output=LIST
                           specify content to report on avail sub-command
                           regular output. elements accepted in LIST are:
-                          \`modulepath', \`alias', \`dirwsym', \`indesym',
-                          \`sym', \`tag', \`key', \`hidden', \`variant',
-                          \`variantifspec' and \`via' (elements in LIST are
-                          separated by \`:') [$availoutput]
+                          \`modulepath', \`alias', \`provided-alias',
+                          \`dirwsym', \`indesym', \`sym', \`tag', \`key',
+                          \`hidden', \`variant', \`variantifspec' and \`via'
+                          (elements in LIST are separated by \`:')
+                          [$availoutput]
   --with-avail-terse-output=LIST
                           specify content to report on avail sub-command
                           terse output. elements accepted in LIST are:
-                          \`modulepath', \`alias', \`dirwsym', \`indesym',
-                          \`sym', \`tag', \`key', \`hidden', \`variant' and
-                          \`variantifspec' (elements in LIST are separated by
-                          \`:') [$availterseoutput]
+                          \`modulepath', \`alias', \`provided-alias',
+                          \`dirwsym', \`indesym', \`sym', \`tag', \`key',
+                          \`hidden', \`variant' and \`variantifspec' (elements
+                          in LIST are separated by \`:')
+                          [$availterseoutput]
   --with-list-output=LIST
                           specify content to report on list sub-command
                           regular output. elements accepted in LIST are:
@@ -458,17 +460,19 @@ Optional Packages:
   --with-spider-output=LIST
                           specify content to report on spider sub-command
                           regular output. elements accepted in LIST are:
-                          \`modulepath', \`alias', \`dirwsym', \`indesym',
-                          \`sym', \`tag', \`key', \`hidden', \`variant',
-                          \`variantifspec' and \`via' (elements in LIST are
-                          separated by \`:') [$spideroutput]
+                          \`modulepath', \`alias', \`provided-alias',
+                          \`dirwsym', \`indesym', \`sym', \`tag', \`key',
+                          \`hidden', \`variant', \`variantifspec' and \`via'
+                          (elements in LIST are separated by \`:')
+                          [$spideroutput]
   --with-spider-terse-output=LIST
                           specify content to report on spider sub-command
                           terse output. elements accepted in LIST are:
-                          \`modulepath', \`alias', \`dirwsym', \`indesym',
-                          \`sym', \`tag', \`key', \`hidden', \`variant' and
-                          \`variantifspec' (elements in LIST are separated by
-                          \`:') [$spiderterseoutput]
+                          \`modulepath', \`alias', \`provided-alias',
+                          \`dirwsym', \`indesym', \`sym', \`tag', \`key',
+                          \`hidden', \`variant' and \`variantifspec' (elements
+                          in LIST are separated by \`:')
+                          [$spiderterseoutput]
   --with-variant-shortcut=SHORTCUTLIST
                           define shortcut characters to specify variant names.
                           Each element in SHORTCUTLIST is a variant name
@@ -879,10 +883,10 @@ for arg in "$@"; do
       allowedval=" load ml mod-to-sh purge reload switch switch_unload try-load unload " ;
       check_and_get_package_value_list "abortonerror" "$arg" "$allowedval" "" ;;
    --with-avail-output=*|--without-avail-output)
-      allowedval=" modulepath alias dirwsym indesym sym tag key hidden variant variantifspec via " ;
+      allowedval=" modulepath alias provided-alias dirwsym indesym sym tag key hidden variant variantifspec via " ;
       check_and_get_package_value_list "availoutput" "$arg" "$allowedval" "" ;;
    --with-avail-terse-output=*|--without-avail-terse-output)
-      allowedval=" modulepath alias dirwsym indesym sym tag key hidden variant variantifspec " ;
+      allowedval=" modulepath alias provided-alias dirwsym indesym sym tag key hidden variant variantifspec " ;
       check_and_get_package_value_list "availterseoutput" "$arg" "$allowedval" "" ;;
    --with-list-output=*|--without-list-output)
       allowedval=" header idx variant alias indesym sym tag hidden key " ;
@@ -891,10 +895,10 @@ for arg in "$@"; do
       allowedval=" header idx variant alias indesym sym tag hidden key " ;
       check_and_get_package_value_list "listterseoutput" "$arg" "$allowedval" "" ;;
    --with-spider-output=*|--without-spider-output)
-      allowedval=" modulepath alias dirwsym indesym sym tag key hidden variant variantifspec via " ;
+      allowedval=" modulepath alias provided-alias dirwsym indesym sym tag key hidden variant variantifspec via " ;
       check_and_get_package_value_list "spideroutput" "$arg" "$allowedval" "" ;;
    --with-spider-terse-output=*|--without-spider-terse-output)
-      allowedval=" modulepath alias dirwsym indesym sym tag key hidden variant variantifspec " ;
+      allowedval=" modulepath alias provided-alias dirwsym indesym sym tag key hidden variant variantifspec " ;
       check_and_get_package_value_list "spiderterseoutput" "$arg" "$allowedval" "" ;;
    --with-variant-shortcut=*|--without-variant-shortcut)
       variantshortcut=$(get_package_value "$arg" "") ;;

doc/source/changes.rst

@@ -1323,8 +1323,9 @@ The following Modules configuration option has been introduced on Modules 5.
  Starting version 5.3.1, element ``indesym`` is added to the list of accepted
  values.
 
- Starting version 5.6, elements ``hidden`` and ``via`` is added to the list of
- accepted values. ``via`` is only supported on :mconfig:`avail_output`.
+ Starting version 5.6, elements ``hidden``, ``provided-alias`` and ``via`` are
+ added to the list of accepted values. ``via`` is only supported on
+ :mconfig:`avail_output`.
 
 :mconfig:`list_output`, :mconfig:`list_terse_output`
 

doc/source/design/output-configuration.rst

@@ -60,12 +60,14 @@ Specification
 
 - Accepted elements in value lists are:
 
-  - For ``avail`` options: modulepath, alias, dirwsym, indesym, sym, tag, key,
-    variant, variantifspec, hidden, via (only on regular output)
+  - For ``avail`` options: modulepath, alias, provided-alias, dirwsym,
+    indesym, sym, tag, key, variant, variantifspec, hidden, via (only on
+    regular output)
   - For ``list`` options: header, idx, variant, alias, indesym, sym, tag, key,
     hidden
-  - For ``spider`` options: modulepath, alias, dirwsym, indesym, sym, tag,
-    key, variant, variantifspec, hidden, via (only on regular output)
+  - For ``spider`` options: modulepath, alias, provided-alias, dirwsym,
+    indesym, sym, tag, key, variant, variantifspec, hidden, via (only on
+    regular output)
 
 - If the ``-o``/``--output`` options are wrongly specified
 

doc/source/module.rst

@@ -492,9 +492,9 @@ switches are accepted:
  of the elements in *LIST* does not matter.
 
  Accepted elements in *LIST* for :subcmd:`avail` and :subcmd:`spider`
- sub-command are: *modulepath*, *alias*, *dirwsym*, *indesym*, *sym*, *tag*,
- *key*, *hidden*, *variant*, *variantifspec* and *via*. *via* element is not
- accepted on terse output mode.
+ sub-command are: *modulepath*, *alias*, *provided-alias*, *dirwsym*,
+ *indesym*, *sym*, *tag*, *key*, *hidden*, *variant*, *variantifspec* and
+ *via*. *via* element is not accepted on terse output mode.
 
  Accepted elements in *LIST* for :subcmd:`list` sub-command are: *header*,
  *idx*, *variant*, *alias*, *indesym*, *sym*, *tag*, *hidden* and *key*.
@@ -536,8 +536,8 @@ switches are accepted:
        :subcmd:`spider` sub-commands
 
     .. versionchanged:: 5.6
-       Element *via* added for :subcmd:`avail` and :subcmd:`spider`
-       sub-commands
+       Elements *provided-alias* and *via* added for :subcmd:`avail` and
+       :subcmd:`spider` sub-commands
 
 .. option:: --paginate
 
@@ -3500,11 +3500,13 @@ Extra match search is triggered when:
   triggered to collect commands used in modulefiles or modulercs then match
   them against extra specifier query
 
-If search query does not contain an extra query and if variant information
-should not be reported, no extra match search is performed. If search query
-does not contain any module name and version but contains an extra query or if
-variant information should be reported, extra match search is applied to all
-available modulefiles.
+If search query does not contain an extra query and if variant or provided
+alias information should not be reported, no extra match search is performed.
+If search query does not contain any module name and version but contains an
+extra query or if variant information should be reported, extra match search
+is applied to all available modulefiles. If provided alias information should
+be reported, extra match search is applied to all available modulefiles even
+if search query contains a module specification.
 
 During this specific evaluation, modulefiles are interpreted in *scan* mode.
 This mode aims to collect the different Tcl modulefile commands used. Special
@@ -4577,6 +4579,8 @@ ENVIRONMENT
  Accepted elements that can be set in value list are:
 
  * ``alias``: module aliases.
+ * ``provided-alias``: show module aliases and evaluate all modulefiles to get
+   aliases provided by them.
  * ``dirwsym``: directories associated with symbolic versions.
  * ``hidden``: show all hidden modules.
  * ``indesym``: symbolic versions reported independently from the module or
@@ -4619,7 +4623,7 @@ ENVIRONMENT
        Element ``indesym`` added
 
     .. versionchanged:: 5.6
-       Elements ``hidden`` and ``via`` added
+       Elements ``hidden``, ``provided-alias`` and ``via`` added
 
 .. envvar:: MODULES_AVAIL_TERSE_OUTPUT
 
@@ -4646,7 +4650,7 @@ ENVIRONMENT
        Elements ``variant`` and ``variantifspec`` added
 
     .. versionchanged:: 5.6
-       Element ``hidden`` added
+       Elements ``hidden`` and ``provided-alias`` added
 
 .. envvar:: MODULES_CACHE_BUFFER_BYTES
 
@@ -5526,6 +5530,8 @@ ENVIRONMENT
  Accepted elements that can be set in value list are:
 
  * ``alias``: module aliases.
+ * ``provided-alias``: show module aliases and evaluate all modulefiles to get
+   aliases provided by them.
  * ``dirwsym``: directories associated with symbolic versions.
  * ``hidden``: show all hidden modules.
  * ``indesym``: symbolic versions reported independently from the module or