Skip to content

Commit b179832

Browse files
committed
doc: desc +/- value prefix for opts/configs in NEWS/CHANGES
1 parent 2a64609 commit b179832

File tree

2 files changed

+30
-0
lines changed

2 files changed

+30
-0
lines changed

NEWS.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -136,6 +136,18 @@ Modules 5.3.0 (not yet released)
136136
When set and if a variant is specified in search query, variants and their
137137
possible values are reported along the module they are associated to on
138138
:subcmd:`avail` command output.
139+
* Accept value starting with ``+`` or ``-`` characters on
140+
:option:`--output`/:option:`-o` command-line switches to indicate value
141+
should respectively be appended to or subtracted from current configuration
142+
option value.
143+
* Accept value starting with ``+`` or ``-`` characters on
144+
:mconfig:`avail_output`, :mconfig:`avail_terse_output`,
145+
:mconfig:`list_output`, :mconfig:`list_terse_output`, :mconfig:`colors`,
146+
:mconfig:`protected_envvars`, :mconfig:`shells_with_ksh_fpath`,
147+
:mconfig:`tag_abbrev`, :mconfig:`tag_color_name`,
148+
:mconfig:`variant_shortcut` configuration options to indicate value
149+
should respectively be appended to or subtracted from current configuration
150+
option value.
139151

140152

141153
.. _5.2 release notes:

doc/source/changes.rst

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -822,6 +822,12 @@ The following command line switches appeared on Modules 5.
822822
| 5.3 | :option:`--ignore-cache`, :option:`--ignore-user-rc` |
823823
+------------+-----------------------------------------------------------------+
824824

825+
:option:`--output`
826+
827+
Starting Modules 5.3, this command line switch accepts value prefixed by
828+
``+`` or ``-`` which means value should respectively be appended to or
829+
subtracted from current configuration option value.
830+
825831
Module Sub-Commands
826832
"""""""""""""""""""
827833

@@ -1063,3 +1069,15 @@ The following Modules configuration option has been introduced on Modules 5.
10631069
Starting version 5.3, element ``variantifspec`` is added to the list of
10641070
accepted values. It is added to the default value list of both configuration
10651071
options.
1072+
1073+
Starting Modules 5.3, these configuration options accept value prefixed by
1074+
``+`` or ``-`` which means value should respectively be appended to or
1075+
subtracted from current configuration option value.
1076+
1077+
:mconfig:`list_output`, :mconfig:`list_terse_output`, :mconfig:`colors`,
1078+
:mconfig:`protected_envvars`, :mconfig:`shells_with_ksh_fpath`,
1079+
:mconfig:`tag_abbrev`, :mconfig:`tag_color_name`, :mconfig:`variant_shortcut`
1080+
1081+
Starting Modules 5.3, these configuration options accept value prefixed by
1082+
``+`` or ``-`` which means value should respectively be appended to or
1083+
subtracted from current configuration option value.

0 commit comments

Comments
 (0)