Skip to content

Commit c20b191

Browse files
committed
doc: desc +/- value prefix for opts/configs in man
1 parent b179832 commit c20b191

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

doc/source/module.rst

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -410,6 +410,9 @@ switches are accepted:
410410
The order of the elements in *LIST* does not matter. Module names are the
411411
only content reported when *LIST* is set to an empty value.
412412

413+
*LIST* may be prefixed by ``+`` or ``-`` character to indicate respectively
414+
to append it to or subtract it from current configuration option value.
415+
413416
See also :envvar:`MODULES_AVAIL_OUTPUT` and :envvar:`MODULES_LIST_OUTPUT`.
414417

415418
.. only:: html
@@ -423,6 +426,9 @@ switches are accepted:
423426
Elements *variant* and *variantifspec* added for :subcmd:`avail`
424427
sub-command
425428

429+
.. versionchanged:: 5.3
430+
Prefixes ``+`` and ``-`` added to append and subtract elements
431+
426432
.. option:: --paginate
427433

428434
Pipe all message output into :command:`less` (or if set, to the command
@@ -734,6 +740,10 @@ Module Sub-Commands
734740
If no value is currently set for an option *name*, the mention ``<undef>`` is
735741
reported.
736742

743+
For options whose value is a colon-separated list, *value* may be prefixed by
744+
``+`` or ``-`` character. It indicates respectively to append it to or
745+
subtract it from current option value.
746+
737747
When command-line switch ``--dump-state`` is passed, current
738748
:file:`modulecmd.tcl` state and Modules-related environment variables are
739749
reported in addition to currently set :file:`modulecmd.tcl` options.
@@ -1425,6 +1435,10 @@ Module Sub-Commands
14251435

14261436
.. versionadded:: 4.3
14271437

1438+
.. versionchanged:: 5.3
1439+
*Value* prefixes ``+`` and ``-`` added to append and subtract elements
1440+
to list-value options
1441+
14281442
.. subcmd:: display modulefile...
14291443

14301444
Display information about one or more *modulefiles*. The display sub-command

0 commit comments

Comments
 (0)