Skip to content

Commit 4e8e76e

Browse files
committed
doc: desc +/- value prefix for opts/configs in MIGRATING
1 parent 2a81b73 commit 4e8e76e

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

MIGRATING.rst

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -220,6 +220,46 @@ version higher or equal to ``1.2`` and variant ``toolchain=a`` selected.
220220
.. note:: Module aliases or symbolic versions used either in modulefile
221221
definitions or as extra specifier values are not resolved.
222222

223+
Append or subtract elements to current option value
224+
---------------------------------------------------
225+
226+
For command-line switches and configuration options whose value is a
227+
colon-separated list, it is now possible to append or subtract elements to the
228+
current value. With a ``+`` prefix elements are appended and with a ``-``
229+
prefix elements are subtracted.
230+
231+
This new feature applies to :option:`--output`/:option:`-o` command-line
232+
switches and :mconfig:`avail_output`, :mconfig:`avail_terse_output`,
233+
:mconfig:`list_output`, :mconfig:`list_terse_output`, :mconfig:`colors`,
234+
:mconfig:`protected_envvars`, :mconfig:`shells_with_ksh_fpath`,
235+
:mconfig:`tag_abbrev`, :mconfig:`tag_color_name`, :mconfig:`variant_shortcut`
236+
configuration options.
237+
238+
For instance, to output available *foo* modules without modulepath and tag
239+
information:
240+
241+
.. parsed-literal::
242+
243+
:ps:`$` module -o -modulepath:tag avail foo
244+
:sgrhi:`foo`/1.0 :sgrhi:`foo`/2.0
245+
246+
On following example, terse output mode of *list* sub-command is permanently
247+
updated to report variant information:
248+
249+
.. parsed-literal::
250+
251+
:ps:`$` module config list_terse_output
252+
Modules Release 5.3.0 (2023-XX-XX)
253+
254+
- :sgrhi:`Config. name` ---------.- :sgrhi:`Value (set by if default overridden)` ---------------
255+
list_terse_output header
256+
:ps:`$` module config list_terse_output +variant
257+
:ps:`$` module config list_terse_output
258+
Modules Release 5.3.0 (2023-XX-XX)
259+
260+
- :sgrhi:`Config. name` ---------.- :sgrhi:`Value (set by if default overridden)` ---------------
261+
list_terse_output header:variant (env-var)
262+
223263
224264
v5.2
225265
====

0 commit comments

Comments
 (0)