diff --git a/INSTALL.rst b/INSTALL.rst index 2f19ac99..df615294 100644 --- a/INSTALL.rst +++ b/INSTALL.rst @@ -830,9 +830,9 @@ 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``, ``variant`` - and ``variantifspec`` (elements in LIST are separated by ``:``). The order of - the elements in LIST does not matter. + ``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:key``) This installation option defines the default value of the @@ -852,13 +852,16 @@ instance :instopt:`--without-modulepath<--with-modulepath>`): .. versionchanged:: 5.3.1 Element ``indesym`` added + .. versionchanged:: 5.6 + Element ``hidden`` 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``, ``variant`` and ``variantifspec`` (elements in LIST are separated by - ``:``). The order of the elements in LIST does not matter. + ``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 @@ -878,6 +881,9 @@ instance :instopt:`--without-modulepath<--with-modulepath>`): .. versionchanged:: 5.3.1 Element ``indesym`` added + .. versionchanged:: 5.6 + Element ``hidden`` added + .. instopt:: --with-bashcompletiondir=DIR Directory for Bash completion scripts. When this option is not set Bash @@ -1038,9 +1044,9 @@ instance :instopt:`--without-modulepath<--with-modulepath>`): Specify the content to report on list sub-command regular output in addition to the loaded module names. Elements accepted in LIST are: ``header``, - ``idx``, ``variant``, ``alias``, ``indesym``, ``sym``, ``tag`` and ``key`` - (elements in LIST are separated by ``:``). The order of the elements in LIST - does not matter. (default=\ ``header:idx:variant:sym:tag:key``) + ``idx``, ``variant``, ``alias``, ``indesym``, ``sym``, ``tag``, ``hidden`` + and ``key`` (elements in LIST are separated by ``:``). The order of the + elements in LIST does not matter. (default=\ ``header:idx:variant:sym:tag:key``) This installation option defines the default value of the :mconfig:`list_output` configuration option which could be changed after @@ -1056,13 +1062,16 @@ instance :instopt:`--without-modulepath<--with-modulepath>`): .. versionchanged:: 5.4 Elements ``alias`` and ``indesym`` added + .. versionchanged:: 5.6 + Element ``hidden`` added + .. instopt:: --with-list-terse-output=LIST Specify the content to report on list sub-command terse output in addition to the loaded module names. Elements accepted in LIST are: ``header``, - ``idx``, ``variant``, ``alias``, ``indesym``, ``sym``, ``tag`` and ``key`` - (elements in LIST are separated by ``:``). The order of the elements in LIST - does not matter. (default=\ ``header``) + ``idx``, ``variant``, ``alias``, ``indesym``, ``sym``, ``tag``, ``hidden`` + and ``key`` (elements in LIST are separated by ``:``). The order of the + elements in LIST does not matter. (default=\ ``header``) This installation option defines the default value of the :mconfig:`list_terse_output` configuration option which could be changed @@ -1078,6 +1087,9 @@ instance :instopt:`--without-modulepath<--with-modulepath>`): .. versionchanged:: 5.4 Elements ``alias`` and ``indesym`` added + .. versionchanged:: 5.6 + Element ``hidden`` added + .. instopt:: --with-loadedmodules=MODLIST Default modulefiles to load at Modules initialization time. Each modulefile diff --git a/NEWS.rst b/NEWS.rst index 30f352d0..58537b18 100644 --- a/NEWS.rst +++ b/NEWS.rst @@ -54,6 +54,12 @@ Modules 5.6.0 (not yet released) * The :subcmd:`lint` sub-command now also lint any readable modulecache files when no modulefile specification is passed as argument or if :file:`.modulecache` file location is specifically passed as argument. +* Add the ``hidden`` element in the allowed value list of the + :mconfig:`avail_output`, :mconfig:`avail_terse_output`, + :mconfig:`list_output`, :mconfig:`list_terse_output`, + :mconfig:`spider_output` and :mconfig:`spider_terse_output` configuration + options. When set, it is equivalent to use :option:`--all` option: hidden + modules are show. .. _Security policy: https://github.com/envmodules/modules/blob/main/SECURITY.md .. _Modules chat room: https://matrix.to/#/#modules:matrix.org diff --git a/doc/source/changes.rst b/doc/source/changes.rst index 518a46bd..5ab9dffa 100644 --- a/doc/source/changes.rst +++ b/doc/source/changes.rst @@ -1228,6 +1228,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, element ``hidden`` is added to the list of accepted + values. + :mconfig:`list_output`, :mconfig:`list_terse_output` Starting Modules 5.3, these configuration options accept value prefixed by @@ -1237,6 +1240,9 @@ The following Modules configuration option has been introduced on Modules 5. Starting version 5.4, elements ``alias`` and ``indesym`` are added to the list of accepted values. + Starting version 5.6, element ``hidden`` is added to the list of accepted + values. + :mconfig:`colors`, :mconfig:`protected_envvars`, :mconfig:`shells_with_ksh_fpath`, :mconfig:`tag_abbrev`, :mconfig:`tag_color_name`, :mconfig:`variant_shortcut` diff --git a/doc/source/module.rst b/doc/source/module.rst index 46eb6f7e..0f0ee8c8 100644 --- a/doc/source/module.rst +++ b/doc/source/module.rst @@ -451,11 +451,11 @@ switches are accepted: does not matter. Accepted elements in *LIST* for :subcmd:`avail` sub-command are: - *modulepath*, *alias*, *dirwsym*, *indesym*, *sym*, *tag*, *key*, *variant* - and *variantifspec*. + *modulepath*, *alias*, *dirwsym*, *indesym*, *sym*, *tag*, *key*, *hidden*, + *variant* and *variantifspec*. Accepted elements in *LIST* for :subcmd:`list` sub-command are: *header*, - *idx*, *variant*, *alias*, *indesym*, *sym*, *tag* and *key*. + *idx*, *variant*, *alias*, *indesym*, *sym*, *tag*, *hidden* and *key*. The order of the elements in *LIST* does not matter. Module names are the only content reported when *LIST* is set to an empty value. @@ -485,6 +485,10 @@ switches are accepted: .. versionchanged:: 5.4 Elements *alias* and *indesym* added for :subcmd:`list` sub-command + .. versionchanged:: 5.6 + Element *hidden* added for :subcmd:`avail` and :subcmd:`list` + sub-commands + .. option:: --paginate Pipe all message output into :command:`less` (or if set, to the command @@ -4283,6 +4287,7 @@ ENVIRONMENT * ``alias``: module aliases. * ``dirwsym``: directories associated with symbolic versions. + * ``hidden``: show all hidden modules. * ``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. @@ -4320,6 +4325,9 @@ ENVIRONMENT .. versionchanged:: 5.3.1 Element ``indesym`` added + .. versionchanged:: 5.6 + Element ``hidden`` added + .. envvar:: MODULES_AVAIL_TERSE_OUTPUT A colon separated list of the elements to report in addition to module names @@ -4343,6 +4351,9 @@ ENVIRONMENT .. versionchanged:: 5.3 Elements ``variant`` and ``variantifspec`` added + .. versionchanged:: 5.6 + Element ``hidden`` added + .. envvar:: MODULES_CACHE_BUFFER_BYTES Size of the buffer used when reading or writing cache files. Accepted values @@ -4733,6 +4744,7 @@ ENVIRONMENT * ``alias``: module aliases targeting loaded modules. * ``header``: sentence to introduce the list of loaded modules or to state that no modules are loaded currently. + * ``hidden``: show hidden loaded modules. * ``idx``: index position of each loaded module. * ``indesym``: symbolic versions reported independently from the loaded module they are attached to. @@ -4759,6 +4771,9 @@ ENVIRONMENT .. versionchanged:: 5.4 Elements ``alias`` and ``indesym`` added + .. versionchanged:: 5.6 + Element ``hidden`` added + .. envvar:: MODULES_LIST_TERSE_OUTPUT A colon separated list of the elements to report in addition to module names @@ -4785,6 +4800,9 @@ ENVIRONMENT .. versionchanged:: 5.4 Elements ``alias`` and ``indesym`` added + .. versionchanged:: 5.6 + Element ``hidden`` added + .. envvar:: MODULES_LOGGED_EVENTS A colon separated list of the events to log. Accepted events that can be set