Skip to content

Commit d214bc1

Browse files
committed
doc: define abbreviation for warning tag
Signed-off-by: Xavier Delaruelle <[email protected]>
1 parent a5f61ea commit d214bc1

File tree

2 files changed

+6
-3
lines changed

2 files changed

+6
-3
lines changed

INSTALL.rst

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1345,7 +1345,7 @@ instance :instopt:`--without-modulepath<--with-modulepath>`):
13451345
Define the abbreviation to use when reporting each module tag. Each element
13461346
in ABBRVLIST is a tag name associated to an abbreviation string (elements in
13471347
ABBRVLIST are separated by ``:``).
1348-
(default=\ ``auto-loaded=aL:loaded=L:hidden=H:hidden-loaded=H:forbidden=F:nearly-forbidden=nF:sticky=S:super-sticky=sS:keep-loaded=kL``)
1348+
(default=\ ``auto-loaded=aL:loaded=L:hidden=H:hidden-loaded=H:forbidden=F:nearly-forbidden=nF:sticky=S:super-sticky=sS:keep-loaded=kL:warning=W``)
13491349

13501350
This installation option defines the default value of the
13511351
:mconfig:`tag_abbrev` configuration option which could be changed after
@@ -1358,6 +1358,9 @@ instance :instopt:`--without-modulepath<--with-modulepath>`):
13581358
.. versionchanged:: 5.1
13591359
Abbreviation for ``keep-loaded`` tag added
13601360

1361+
.. versionchanged:: 5.6
1362+
Abbreviation for ``warning`` tag added
1363+
13611364
.. instopt:: --with-tag-color-name=TAGLIST
13621365

13631366
Define the tags whose graphical rendering should be applied over their name
@@ -1668,7 +1671,7 @@ installation.
16681671
| :mconfig:`tag_abbrev` | auto-loaded=aL:loaded=L:hidden=H:\ | :instopt:`--with-tag-abbrev`, | | |
16691672
| | hidden-loaded=H:forbidden=F:nearly-\ | :envvar:`MODULES_TAG_ABBREV` | | |
16701673
| | forbidden=nF:sticky=S:super-sticky=sS:\ | | | |
1671-
| | keep-loaded=kL | | | |
1674+
| | keep-loaded=kL:warning=W | | | |
16721675
+-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
16731676
| :mconfig:`tag_color_name` | *Empty by default* | :instopt:`--with-tag-color-name`, | | |
16741677
| | | :envvar:`MODULES_TAG_COLOR_NAME` | | |

doc/source/module.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1593,7 +1593,7 @@ Module Sub-Commands
15931593

15941594
Abbreviations to use to report module tags.
15951595

1596-
Default value is ``auto-loaded=aL:loaded=L:hidden=H:hidden-loaded=H:forbidden=F:nearly-forbidden=nF:sticky=S:super-sticky=sS:keep-loaded=kL``.
1596+
Default value is ``auto-loaded=aL:loaded=L:hidden=H:hidden-loaded=H:forbidden=F:nearly-forbidden=nF:sticky=S:super-sticky=sS:keep-loaded=kL:warning=W``.
15971597
It can be changed at installation time with :instopt:`--with-tag-abbrev`
15981598
option. The :envvar:`MODULES_TAG_ABBREV` environment variable is defined by
15991599
:subcmd:`config` sub-command when changing this configuration option from

0 commit comments

Comments
 (0)