Skip to content

Commit a446108

Browse files
committed
doc: define color in palettes for warning tag
Signed-off-by: Xavier Delaruelle <[email protected]>
1 parent 282a8ab commit a446108

File tree

2 files changed

+17
-8
lines changed

2 files changed

+17
-8
lines changed

INSTALL.rst

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -941,12 +941,12 @@ instance :instopt:`--without-modulepath<--with-modulepath>`):
941941
this abbreviation to get a graphical rendering. Each basic tag has by default
942942
a key set in the color palette, based on its abbreviated string: auto-loaded
943943
(``aL``), forbidden (``F``), hidden and hidden-loaded (``H``), loaded
944-
(``L``), nearly-forbidden (``nF``), sticky (``S``), super-sticky (``sS``) and
945-
keep-loaded (``kL``).
944+
(``L``), nearly-forbidden (``nF``), sticky (``S``), super-sticky (``sS``),
945+
keep-loaded (``kL``) and warning (``W``).
946946

947947
For a complete SGR code reference, see
948948
https://en.wikipedia.org/wiki/ANSI_escape_code#SGR_(Select_Graphic_Rendition)_parameters.
949-
(default=\ ``hi=1:db=2:tr=2:se=2:er=91:wa=93:me=95:in=94:mp=1;94:di=94:al=96:va=93:sy=95:de=4:cm=92:aL=100:L=90;47:H=2:F=41:nF=43:S=46:sS=44:kL=30;48;5;109``)
949+
(default=\ ``hi=1:db=2:tr=2:se=2:er=91:wa=93:me=95:in=94:mp=1;94:di=94:al=96:va=93:sy=95:de=4:cm=92:aL=100:L=90;47:H=2:F=41:nF=43:S=46:sS=44:kL=30;48;5;109:W=30;43``)
950950

951951
This installation option defines the default value of the :mconfig:`colors`
952952
configuration option when :mconfig:`term_background` configuration option
@@ -971,6 +971,9 @@ instance :instopt:`--without-modulepath<--with-modulepath>`):
971971
.. versionchanged:: 5.1
972972
Output item for keep-loaded module tag (``kL``) added
973973

974+
.. versionchanged:: 5.6
975+
Output item for warning module tag (``W``) added
976+
974977
.. instopt:: --with-editor=BIN
975978

976979
Name or full path of default editor program to use to open modulefile through
@@ -1031,7 +1034,7 @@ instance :instopt:`--without-modulepath<--with-modulepath>`):
10311034
Default color set to apply if terminal background color is defined to
10321035
``light``. Expect the same syntax than described for
10331036
:instopt:`--with-dark-background-colors`.
1034-
(default=\ ``hi=1:db=2:tr=2:se=2:er=31:wa=33:me=35:in=34:mp=1;34:di=34:al=36:va=33:sy=35:de=4:cm=32:aL=107:L=47:H=2:F=101:nF=103:S=106:sS=104:kL=48;5;109``)
1037+
(default=\ ``hi=1:db=2:tr=2:se=2:er=31:wa=33:me=35:in=34:mp=1;34:di=34:al=36:va=33:sy=35:de=4:cm=32:aL=107:L=47:H=2:F=101:nF=103:S=106:sS=104:kL=48;5;109:W=103``)
10351038

10361039
This installation option defines the default value of the :mconfig:`colors`
10371040
configuration option when :mconfig:`term_background` configuration option
@@ -1056,6 +1059,9 @@ instance :instopt:`--without-modulepath<--with-modulepath>`):
10561059
.. versionchanged:: 5.1
10571060
Output item for keep-loaded module tag (``kL``) added
10581061

1062+
.. versionchanged:: 5.6
1063+
Output item for warning module tag (``W``) added
1064+
10591065
.. instopt:: --with-list-output=LIST
10601066

10611067
Specify the content to report on list sub-command regular output in addition
@@ -1537,7 +1543,7 @@ installation.
15371543
| :mconfig:`colors` | hi=1:db=2:tr=2:se=2:er=91:wa=93:\ | :instopt:`--with-dark-background-colors`, | | |
15381544
| | me=95:in=94:mp=1;94:di=94:al=96:va=93:sy=95\ | :instopt:`--with-light-background-colors`, | | |
15391545
| | :de=4:cm=92:aL=100:L=90;47:H=2:F=41:nF=43:\ | :envvar:`MODULES_COLORS` | | |
1540-
| | S=46:sS=44:kL=30;48;5;109 | | | |
1546+
| | S=46:sS=44:kL=30;48;5;109:W=30;43 | | | |
15411547
+-----------------------------------+----------------------------------------------+----------------------------------------------+--------------+-----------+
15421548
| :mconfig:`conflict_unload` | ``0`` | :instopt:`--enable-conflict-unload`, | | |
15431549
| | | :envvar:`MODULES_CONFLICT_UNLOAD` | | |

doc/source/module.rst

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1042,7 +1042,7 @@ Module Sub-Commands
10421042

10431043
Chosen colors to highlight output items.
10441044

1045-
Default value is ``hi=1:db=2:tr=2:se=2:er=91:wa=93:me=95:in=94:mp=1;94:di=94:al=96:va=93:sy=95:de=4:cm=92:aL=100:L=90;47:H=2:F=41:nF=43:S=46:sS=44:kL=30;48;5;109``.
1045+
Default value is ``hi=1:db=2:tr=2:se=2:er=91:wa=93:me=95:in=94:mp=1;94:di=94:al=96:va=93:sy=95:de=4:cm=92:aL=100:L=90;47:H=2:F=41:nF=43:S=46:sS=44:kL=30;48;5;109:W=30;43``.
10461046
It can be changed at installation time with
10471047
:instopt:`--with-dark-background-colors` or
10481048
:instopt:`--with-light-background-colors` options in conjunction with
@@ -4731,8 +4731,8 @@ ENVIRONMENT
47314731
abbreviation to get a graphical rendering. Each basic tag has by default a
47324732
key set in the color palette, based on its abbreviated string: auto-loaded
47334733
(``aL``), forbidden (``F``), hidden and hidden-loaded (``H``), loaded
4734-
(``L``), nearly-forbidden (``nF``), sticky (``S``), super-sticky (``sS``) and
4735-
keep-loaded (``kL``).
4734+
(``L``), nearly-forbidden (``nF``), sticky (``S``), super-sticky (``sS``),
4735+
keep-loaded (``kL``) and warning (``W``).
47364736

47374737
See the Select Graphic Rendition (SGR) section in the documentation of the
47384738
text terminal that is used for permitted values and their meaning as
@@ -4770,6 +4770,9 @@ ENVIRONMENT
47704770
.. versionchanged:: 5.1
47714771
Output item for keep-loaded module tag (``kL``) added
47724772

4773+
.. versionchanged:: 5.6
4774+
Output item for warning module tag (``W``) added
4775+
47734776
.. envvar:: MODULES_CONFLICT_UNLOAD
47744777

47754778
If set to ``1``, enable automated unload of conflicting modules when loading

0 commit comments

Comments
 (0)