Skip to content

Commit 62ad929

Browse files
xdelaruellexdelaruelle
committed
install/doc: desc. variantifspec addition to avail_{,terse_}output
variantifspec new value is also added to the default list of value for these configuration options.
1 parent 8594395 commit 62ad929

File tree

4 files changed

+38
-23
lines changed

4 files changed

+38
-23
lines changed

‎INSTALL.rst‎

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -716,9 +716,10 @@ instance :instopt:`--without-modulepath<--with-modulepath>`):
716716

717717
Specify the content to report on avail sub-command regular output in addition
718718
to the available module names. Elements accepted in LIST are: ``modulepath``,
719-
``alias``, ``dirwsym``, ``sym``, ``tag``, ``key`` and ``variant`` (elements
720-
in LIST are separated by ``:``). The order of the elements in LIST does not
721-
matter. (default=\ ``modulepath:alias:dirwsym:sym:tag:key``)
719+
``alias``, ``dirwsym``, ``sym``, ``tag``, ``key``, ``variant`` and
720+
``variantifspec`` (elements in LIST are separated by ``:``). The order of
721+
the elements in LIST does not matter.
722+
(default=\ ``modulepath:alias:dirwsym:sym:tag:variantifspec:key``)
722723

723724
This installation option defines the default value of the
724725
:mconfig:`avail_output` configuration option which could be changed after
@@ -731,14 +732,17 @@ instance :instopt:`--without-modulepath<--with-modulepath>`):
731732
.. versionchanged:: 5.3
732733
Element ``variant`` added
733734

735+
.. versionchanged:: 5.3
736+
Element ``variantifspec`` added and set by default
737+
734738
.. instopt:: --with-avail-terse-output=LIST
735739

736740
Specify the content to report on avail sub-command terse output in addition
737741
addition to the available module names. Elements accepted in LIST are:
738-
``modulepath``, ``alias``, ``dirwsym``, ``sym``, ``tag``, ``key`` and
739-
``variant`` (elements in LIST are separated by ``:``). The order of the
740-
elements in LIST does not matter.
741-
(default=\ ``modulepath:alias:dirwsym:sym:tag``)
742+
``modulepath``, ``alias``, ``dirwsym``, ``sym``, ``tag``, ``key``,
743+
``variant`` and ``variantifspec`` (elements in LIST are separated by ``:``).
744+
The order of the elements in LIST does not matter.
745+
(default=\ ``modulepath:alias:dirwsym:sym:tag:variantifspec``)
742746

743747
This installation option defines the default value of the
744748
:mconfig:`avail_terse_output` configuration option which could be changed
@@ -751,6 +755,9 @@ instance :instopt:`--without-modulepath<--with-modulepath>`):
751755
.. versionchanged:: 5.3
752756
Element ``variant`` added
753757

758+
.. versionchanged:: 5.3
759+
Element ``variantifspec`` added and set by default
760+
754761
.. instopt:: --with-bashcompletiondir=DIR
755762

756763
Directory for Bash completion scripts. When this option is not set Bash
@@ -1256,12 +1263,12 @@ installation.
12561263
| | | :envvar:`MODULES_AVAIL_INDEPTH`, | | |
12571264
| | | :option:`--indepth`, :option:`--no-indepth` | | |
12581265
+-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1259-
| :mconfig:`avail_output` | ``modulepath:alias:dirwsym:sym:tag:key`` | :instopt:`--with-avail-output`, | | |
1260-
| | | :envvar:`MODULES_AVAIL_OUTPUT`, | | |
1266+
| :mconfig:`avail_output` | modulepath:alias:dirwsym:sym:tag:\ | :instopt:`--with-avail-output`, | | |
1267+
| | variantifspec:key | :envvar:`MODULES_AVAIL_OUTPUT`, | | |
12611268
| | | :option:`--output` | | |
12621269
+-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
1263-
| :mconfig:`avail_terse_output` | ``modulepath:alias:dirwsym:sym:tag`` | :instopt:`--with-avail-terse-output`, | | |
1264-
| | | :envvar:`MODULES_AVAIL_TERSE_OUTPUT`, | | |
1270+
| :mconfig:`avail_terse_output` | modulepath:alias:dirwsym:sym:tag:\ | :instopt:`--with-avail-terse-output`, | | |
1271+
| | variantifspec | :envvar:`MODULES_AVAIL_TERSE_OUTPUT`, | | |
12651272
| | | :option:`--output` | | |
12661273
+-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
12671274
| :mconfig:`cache_buffer_bytes` | ``32768`` | :envvar:`MODULES_CACHE_BUFFER_BYTES` | | |

‎configure‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -119,8 +119,8 @@ nearlyforbiddendays=14
119119
tagabbrev='auto-loaded=aL:loaded=L:hidden=H:hidden-loaded=H:forbidden=F:nearly-forbidden=nF:sticky=S:super-sticky=sS:keep-loaded=kL'
120120
tagcolorname=
121121
mcookieversioncheck=y
122-
availoutput='modulepath:alias:dirwsym:sym:tag:key'
123-
availterseoutput='modulepath:alias:dirwsym:sym:tag'
122+
availoutput='modulepath:alias:dirwsym:sym:tag:variantifspec:key'
123+
availterseoutput='modulepath:alias:dirwsym:sym:tag:variantifspec'
124124
listoutput='header:idx:variant:sym:tag:key'
125125
listterseoutput='header'
126126
editor='vi'
@@ -373,14 +373,14 @@ Optional Packages:
373373
specify content to report on avail sub-command
374374
regular output. elements accepted in LIST are:
375375
\`modulepath', \`alias', \`dirwsym', \`sym', \`tag',
376-
\`key' and \`variant' (elements in LIST are
377-
separated by \`:') [$availoutput]
376+
\`key', \`variant' and \`variantifspec' (elements in
377+
LIST are separated by \`:') [$availoutput]
378378
--with-avail-terse-output=LIST
379379
specify content to report on avail sub-command
380380
terse output. elements accepted in LIST are:
381381
\`modulepath', \`alias', \`dirwsym', \`sym', \`tag',
382-
\`key' and \`variant' (elements in LIST are
383-
separated by \`:') [$availterseoutput]
382+
\`key', \`variant' and \`variantifspec' (elements in
383+
LIST are separated by \`:') [$availterseoutput]
384384
--with-list-output=LIST
385385
specify content to report on list sub-command
386386
regular output. elements accepted in LIST are:
@@ -730,7 +730,7 @@ for arg in "$@"; do
730730
tagcolorname=$(get_package_value "$arg") ;;
731731
--with-avail-output*|--without-avail-output)
732732
availoutput=$(get_package_value "$arg" "$availoutput") ;
733-
allowedval=" modulepath alias dirwsym sym tag key variant " ;
733+
allowedval=" modulepath alias dirwsym sym tag key variant variantifspec " ;
734734
ORIG_IFS=$IFS ;
735735
IFS=: ;
736736
for val in $availoutput; do
@@ -742,7 +742,7 @@ for arg in "$@"; do
742742
IFS=$ORIG_IFS ;;
743743
--with-avail-terse-output*|--without-avail-terse-output)
744744
availterseoutput=$(get_package_value "$arg" "$availterseoutput") ;
745-
allowedval=" modulepath alias dirwsym sym tag key variant " ;
745+
allowedval=" modulepath alias dirwsym sym tag key variant variantifspec " ;
746746
ORIG_IFS=$IFS ;
747747
IFS=: ;
748748
for val in $availterseoutput; do

‎doc/source/changes.rst‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1043,3 +1043,7 @@ The following Modules configuration option has been introduced on Modules 5.
10431043

10441044
Starting version 5.3, element ``variant`` is added to the list of accepted
10451045
values.
1046+
1047+
Starting version 5.3, element ``variantifspec`` is added to the list of
1048+
accepted values. It is added to the default value list of both configuration
1049+
options.

‎doc/source/module.rst‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -401,7 +401,8 @@ switches are accepted:
401401
does not matter.
402402

403403
Accepted elements in *LIST* for :subcmd:`avail` sub-command are:
404-
*modulepath*, *alias*, *dirwsym*, *sym*, *tag*, *key* and *variant*.
404+
*modulepath*, *alias*, *dirwsym*, *sym*, *tag*, *key*, *variant* and
405+
*variantifspec*.
405406

406407
Accepted elements in *LIST* for :subcmd:`list` sub-command are: *header*,
407408
*idx*, *variant*, *sym*, *tag* and *key*.
@@ -419,7 +420,8 @@ switches are accepted:
419420
Element *variant* added for :subcmd:`list` sub-command
420421

421422
.. versionchanged:: 5.3
422-
Element *variant* added for :subcmd:`avail` sub-command
423+
Elements *variant* and *variantifspec* added for :subcmd:`avail`
424+
sub-command
423425

424426
.. option:: --paginate
425427

@@ -3748,6 +3750,8 @@ ENVIRONMENT
37483750
* ``tag``: tags associated with available modules.
37493751
* ``variant``: variants and their possible values associated with available
37503752
modules.
3753+
* ``variantifspec``: like ``variant`` but only if a variant has been
3754+
specified in search query.
37513755

37523756
The order of the elements in the list does not matter. Module names are the
37533757
only content reported when *LIST* is set to an empty value.
@@ -3766,7 +3770,7 @@ ENVIRONMENT
37663770
.. versionadded:: 4.7
37673771

37683772
.. versionchanged:: 5.3
3769-
Element ``variant`` added
3773+
Elements ``variant`` and ``variantifspec`` added
37703774

37713775
.. envvar:: MODULES_AVAIL_TERSE_OUTPUT
37723776

@@ -3789,7 +3793,7 @@ ENVIRONMENT
37893793
.. versionadded:: 4.7
37903794

37913795
.. versionchanged:: 5.3
3792-
Element ``variant`` added
3796+
Elements ``variant`` and ``variantifspec`` added
37933797

37943798
.. envvar:: MODULES_CACHE_BUFFER_BYTES
37953799

0 commit comments

Comments
 (0)