Skip to content

Commit c043e7d

Browse files
committed
doc: desc. always see hidden modules in MIGRATING
Signed-off-by: Xavier Delaruelle <[email protected]>
1 parent 9f8efdf commit c043e7d

File tree

2 files changed

+27
-1
lines changed

2 files changed

+27
-1
lines changed

MIGRATING.rst

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,32 @@ Modules. It provides an overview of the new features and changed behaviors
88
that will be encountered when upgrading.
99

1010

11+
v5.6 (not yet released)
12+
=======================
13+
14+
Always see hidden modules
15+
-------------------------
16+
17+
The ``hidden`` element is a new allowed value for the :mconfig:`avail_output`,
18+
:mconfig:`avail_terse_output`, :mconfig:`list_output`,
19+
:mconfig:`list_terse_output`, :mconfig:`spider_output` and
20+
:mconfig:`spider_terse_output` configuration options. When set into the value
21+
list of these options hidden modules are shown on the output of corresponding
22+
commands (:subcmd:`avail`, :subcmd:`list` and :subcmd:`spider`).
23+
24+
.. parsed-literal::
25+
26+
--------------- :sgrdi:`/path/to/modulefiles` ---------------
27+
bar/1.0
28+
:ps:`$` module config avail_output +hidden
29+
:ps:`$` ml av
30+
--------------- :sgrdi:`/path/to/modulefiles` ---------------
31+
bar/1.0 foo/1.0 <H>
32+
33+
When set, this is equivalent to always adding the :option:`--all` command-line
34+
option.
35+
36+
1137
v5.5
1238
====
1339

NEWS.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ Modules 5.6.0 (not yet released)
8787
:mconfig:`list_output`, :mconfig:`list_terse_output`,
8888
:mconfig:`spider_output` and :mconfig:`spider_terse_output` configuration
8989
options. When set, it is equivalent to use :option:`--all` option: hidden
90-
modules are show.
90+
modules are shown.
9191
* Produce a single output for multi pattern :subcmd:`avail` search rather than
9292
a separate output for each submitted pattern.
9393
* Produce a single output for multi pattern :subcmd:`whatis` search rather

0 commit comments

Comments
 (0)