mirror of
https://github.com/facebook/sapling.git
synced 2025-01-08 14:46:47 +03:00
color: update main documentation
Now that the feature no longer lives in the extension, we document it in the help of the core config. This include the new 'ui.color' option introduced in the previous changesets. As a result the color extensions can now be deprecated. This is a documentation patch only; color is still disabled by default.
This commit is contained in:
Pierre-Yves David
parent
677892a9d7
commit
a29094b506
@ -15,6 +15,7 @@
|
||||
<DirectoryRef Id="INSTALLDIR">
|
||||
<Directory Id="helpdir" Name="help" FileSource="$(var.SourceDir)">
|
||||
<Component Id="help.root" Guid="$(var.help.root.guid)" Win64='$(var.IsX64)'>
|
||||
<File Name="color.txt" />
|
||||
<File Name="config.txt" KeyPath="yes" />
|
||||
<File Name="dates.txt" />
|
||||
<File Name="diffs.txt" />
|
||||
|
||||
169
hgext/color.py
169
hgext/color.py
@ -5,169 +5,20 @@
|
||||
# This software may be used and distributed according to the terms of the
|
||||
# GNU General Public License version 2 or any later version.
|
||||
|
||||
'''colorize output from some commands
|
||||
'''enable Mercurial color mode (DEPRECATED)
|
||||
|
||||
The color extension colorizes output from several Mercurial commands.
|
||||
For example, the diff command shows additions in green and deletions
|
||||
in red, while the status command shows modified files in magenta. Many
|
||||
other commands have analogous colors. It is possible to customize
|
||||
these colors.
|
||||
This extensions enable Mercurial color mode. The feature is now directly
|
||||
available in Mercurial core. You can access it using::
|
||||
|
||||
Effects
|
||||
-------
|
||||
[ui]
|
||||
color = auto
|
||||
|
||||
Other effects in addition to color, like bold and underlined text, are
|
||||
also available. By default, the terminfo database is used to find the
|
||||
terminal codes used to change color and effect. If terminfo is not
|
||||
available, then effects are rendered with the ECMA-48 SGR control
|
||||
function (aka ANSI escape codes).
|
||||
|
||||
The available effects in terminfo mode are 'blink', 'bold', 'dim',
|
||||
'inverse', 'invisible', 'italic', 'standout', and 'underline'; in
|
||||
ECMA-48 mode, the options are 'bold', 'inverse', 'italic', and
|
||||
'underline'. How each is rendered depends on the terminal emulator.
|
||||
Some may not be available for a given terminal type, and will be
|
||||
silently ignored.
|
||||
|
||||
If the terminfo entry for your terminal is missing codes for an effect
|
||||
or has the wrong codes, you can add or override those codes in your
|
||||
configuration::
|
||||
|
||||
[color]
|
||||
terminfo.dim = \E[2m
|
||||
|
||||
where '\E' is substituted with an escape character.
|
||||
|
||||
Labels
|
||||
------
|
||||
|
||||
Text receives color effects depending on the labels that it has. Many
|
||||
default Mercurial commands emit labelled text. You can also define
|
||||
your own labels in templates using the label function, see :hg:`help
|
||||
templates`. A single portion of text may have more than one label. In
|
||||
that case, effects given to the last label will override any other
|
||||
effects. This includes the special "none" effect, which nullifies
|
||||
other effects.
|
||||
|
||||
Labels are normally invisible. In order to see these labels and their
|
||||
position in the text, use the global --color=debug option. The same
|
||||
anchor text may be associated to multiple labels, e.g.
|
||||
|
||||
[log.changeset changeset.secret|changeset: 22611:6f0a53c8f587]
|
||||
|
||||
The following are the default effects for some default labels. Default
|
||||
effects may be overridden from your configuration file::
|
||||
|
||||
[color]
|
||||
status.modified = blue bold underline red_background
|
||||
status.added = green bold
|
||||
status.removed = red bold blue_background
|
||||
status.deleted = cyan bold underline
|
||||
status.unknown = magenta bold underline
|
||||
status.ignored = black bold
|
||||
|
||||
# 'none' turns off all effects
|
||||
status.clean = none
|
||||
status.copied = none
|
||||
|
||||
qseries.applied = blue bold underline
|
||||
qseries.unapplied = black bold
|
||||
qseries.missing = red bold
|
||||
|
||||
diff.diffline = bold
|
||||
diff.extended = cyan bold
|
||||
diff.file_a = red bold
|
||||
diff.file_b = green bold
|
||||
diff.hunk = magenta
|
||||
diff.deleted = red
|
||||
diff.inserted = green
|
||||
diff.changed = white
|
||||
diff.tab =
|
||||
diff.trailingwhitespace = bold red_background
|
||||
|
||||
# Blank so it inherits the style of the surrounding label
|
||||
changeset.public =
|
||||
changeset.draft =
|
||||
changeset.secret =
|
||||
|
||||
resolve.unresolved = red bold
|
||||
resolve.resolved = green bold
|
||||
|
||||
bookmarks.active = green
|
||||
|
||||
branches.active = none
|
||||
branches.closed = black bold
|
||||
branches.current = green
|
||||
branches.inactive = none
|
||||
|
||||
tags.normal = green
|
||||
tags.local = black bold
|
||||
|
||||
rebase.rebased = blue
|
||||
rebase.remaining = red bold
|
||||
|
||||
shelve.age = cyan
|
||||
shelve.newest = green bold
|
||||
shelve.name = blue bold
|
||||
|
||||
histedit.remaining = red bold
|
||||
|
||||
Custom colors
|
||||
-------------
|
||||
|
||||
Because there are only eight standard colors, this module allows you
|
||||
to define color names for other color slots which might be available
|
||||
for your terminal type, assuming terminfo mode. For instance::
|
||||
|
||||
color.brightblue = 12
|
||||
color.pink = 207
|
||||
color.orange = 202
|
||||
|
||||
to set 'brightblue' to color slot 12 (useful for 16 color terminals
|
||||
that have brighter colors defined in the upper eight) and, 'pink' and
|
||||
'orange' to colors in 256-color xterm's default color cube. These
|
||||
defined colors may then be used as any of the pre-defined eight,
|
||||
including appending '_background' to set the background to that color.
|
||||
|
||||
Modes
|
||||
-----
|
||||
|
||||
By default, the color extension will use ANSI mode (or win32 mode on
|
||||
Windows) if it detects a terminal. To override auto mode (to enable
|
||||
terminfo mode, for example), set the following configuration option::
|
||||
|
||||
[color]
|
||||
mode = terminfo
|
||||
|
||||
Any value other than 'ansi', 'win32', 'terminfo', or 'auto' will
|
||||
disable color.
|
||||
|
||||
Note that on some systems, terminfo mode may cause problems when using
|
||||
color with the pager extension and less -R. less with the -R option
|
||||
will only display ECMA-48 color codes, and terminfo mode may sometimes
|
||||
emit codes that less doesn't understand. You can work around this by
|
||||
either using ansi mode (or auto mode), or by using less -r (which will
|
||||
pass through all terminal control codes, not just color control
|
||||
codes).
|
||||
|
||||
On some systems (such as MSYS in Windows), the terminal may support
|
||||
a different color mode than the pager (activated via the "pager"
|
||||
extension). It is possible to define separate modes depending on whether
|
||||
the pager is active::
|
||||
|
||||
[color]
|
||||
mode = auto
|
||||
pagermode = ansi
|
||||
|
||||
If ``pagermode`` is not defined, the ``mode`` will be used.
|
||||
See :hg:`help color` for details.
|
||||
'''
|
||||
|
||||
from __future__ import absolute_import
|
||||
|
||||
from mercurial import (
|
||||
color,
|
||||
commands
|
||||
)
|
||||
from mercurial import color
|
||||
|
||||
# Note for extension authors: ONLY specify testedwith = 'ships-with-hg-core' for
|
||||
# extensions which SHIP WITH MERCURIAL. Non-mainline extensions should
|
||||
@ -178,9 +29,3 @@ testedwith = 'ships-with-hg-core'
|
||||
def extsetup(ui):
|
||||
# change default color config
|
||||
color._enabledbydefault = True
|
||||
for idx, entry in enumerate(commands.globalopts):
|
||||
if entry[1] == 'color':
|
||||
patch = (entry[3].replace(' (EXPERIMENTAL)', ''),)
|
||||
new = entry[:3] + patch + entry[4:]
|
||||
commands.globalopts[idx] = new
|
||||
break
|
||||
|
||||
@ -187,7 +187,6 @@ def _modesetup(ui):
|
||||
default = 'never'
|
||||
if _enabledbydefault:
|
||||
default = 'auto'
|
||||
# experimental config: ui.color
|
||||
config = ui.config('ui', 'color', default)
|
||||
if config == 'debug':
|
||||
return 'debug'
|
||||
|
||||
@ -80,8 +80,7 @@ globalopts = [
|
||||
('', 'color', '',
|
||||
# i18n: 'always', 'auto', 'never', and 'debug' are keywords
|
||||
# and should not be translated
|
||||
_("when to colorize (boolean, always, auto, never, or debug)"
|
||||
" (EXPERIMENTAL)"),
|
||||
_("when to colorize (boolean, always, auto, never, or debug)"),
|
||||
_('TYPE')),
|
||||
('', 'config', [],
|
||||
_('set/override config option (use \'section.name=value\')'),
|
||||
|
||||
134
mercurial/help/color.txt
Normal file
134
mercurial/help/color.txt
Normal file
@ -0,0 +1,134 @@
|
||||
Mercurial can colorizes output from several commands.
|
||||
|
||||
For example, the diff command shows additions in green and deletions
|
||||
in red, while the status command shows modified files in magenta. Many
|
||||
other commands have analogous colors. It is possible to customize
|
||||
these colors.
|
||||
|
||||
To enable color use::
|
||||
|
||||
[ui]
|
||||
color = auto
|
||||
|
||||
Mode
|
||||
====
|
||||
|
||||
Mercurial can use various system to display color. The supported modes are
|
||||
``ansi``, ``win32``, and ``terminfo``. See :hg:`help config.color` for details
|
||||
about how to control the mode
|
||||
|
||||
Effects
|
||||
=======
|
||||
|
||||
Other effects in addition to color, like bold and underlined text, are
|
||||
also available. By default, the terminfo database is used to find the
|
||||
terminal codes used to change color and effect. If terminfo is not
|
||||
available, then effects are rendered with the ECMA-48 SGR control
|
||||
function (aka ANSI escape codes).
|
||||
|
||||
The available effects in terminfo mode are 'blink', 'bold', 'dim',
|
||||
'inverse', 'invisible', 'italic', 'standout', and 'underline'; in
|
||||
ECMA-48 mode, the options are 'bold', 'inverse', 'italic', and
|
||||
'underline'. How each is rendered depends on the terminal emulator.
|
||||
Some may not be available for a given terminal type, and will be
|
||||
silently ignored.
|
||||
|
||||
If the terminfo entry for your terminal is missing codes for an effect
|
||||
or has the wrong codes, you can add or override those codes in your
|
||||
configuration::
|
||||
|
||||
[color]
|
||||
terminfo.dim = \E[2m
|
||||
|
||||
where '\E' is substituted with an escape character.
|
||||
|
||||
Labels
|
||||
======
|
||||
|
||||
Text receives color effects depending on the labels that it has. Many
|
||||
default Mercurial commands emit labelled text. You can also define
|
||||
your own labels in templates using the label function, see :hg:`help
|
||||
templates`. A single portion of text may have more than one label. In
|
||||
that case, effects given to the last label will override any other
|
||||
effects. This includes the special "none" effect, which nullifies
|
||||
other effects.
|
||||
|
||||
Labels are normally invisible. In order to see these labels and their
|
||||
position in the text, use the global --color=debug option. The same
|
||||
anchor text may be associated to multiple labels, e.g.
|
||||
|
||||
[log.changeset changeset.secret|changeset: 22611:6f0a53c8f587]
|
||||
|
||||
The following are the default effects for some default labels. Default
|
||||
effects may be overridden from your configuration file::
|
||||
|
||||
[color]
|
||||
status.modified = blue bold underline red_background
|
||||
status.added = green bold
|
||||
status.removed = red bold blue_background
|
||||
status.deleted = cyan bold underline
|
||||
status.unknown = magenta bold underline
|
||||
status.ignored = black bold
|
||||
|
||||
# 'none' turns off all effects
|
||||
status.clean = none
|
||||
status.copied = none
|
||||
|
||||
qseries.applied = blue bold underline
|
||||
qseries.unapplied = black bold
|
||||
qseries.missing = red bold
|
||||
|
||||
diff.diffline = bold
|
||||
diff.extended = cyan bold
|
||||
diff.file_a = red bold
|
||||
diff.file_b = green bold
|
||||
diff.hunk = magenta
|
||||
diff.deleted = red
|
||||
diff.inserted = green
|
||||
diff.changed = white
|
||||
diff.tab =
|
||||
diff.trailingwhitespace = bold red_background
|
||||
|
||||
# Blank so it inherits the style of the surrounding label
|
||||
changeset.public =
|
||||
changeset.draft =
|
||||
changeset.secret =
|
||||
|
||||
resolve.unresolved = red bold
|
||||
resolve.resolved = green bold
|
||||
|
||||
bookmarks.active = green
|
||||
|
||||
branches.active = none
|
||||
branches.closed = black bold
|
||||
branches.current = green
|
||||
branches.inactive = none
|
||||
|
||||
tags.normal = green
|
||||
tags.local = black bold
|
||||
|
||||
rebase.rebased = blue
|
||||
rebase.remaining = red bold
|
||||
|
||||
shelve.age = cyan
|
||||
shelve.newest = green bold
|
||||
shelve.name = blue bold
|
||||
|
||||
histedit.remaining = red bold
|
||||
|
||||
Custom colors
|
||||
=============
|
||||
|
||||
Because there are only eight standard colors, this module allows you
|
||||
to define color names for other color slots which might be available
|
||||
for your terminal type, assuming terminfo mode. For instance::
|
||||
|
||||
color.brightblue = 12
|
||||
color.pink = 207
|
||||
color.orange = 202
|
||||
|
||||
to set 'brightblue' to color slot 12 (useful for 16 color terminals
|
||||
that have brighter colors defined in the upper eight) and, 'pink' and
|
||||
'orange' to colors in 256-color xterm's default color cube. These
|
||||
defined colors may then be used as any of the pre-defined eight,
|
||||
including appending '_background' to set the background to that color.
|
||||
@ -386,6 +386,33 @@ Supported arguments:
|
||||
If no suitable authentication entry is found, the user is prompted
|
||||
for credentials as usual if required by the remote.
|
||||
|
||||
``color``
|
||||
---------
|
||||
|
||||
Configure the Mercurial color mode. For details about how to define your custom
|
||||
effect and style see :hg:`help color`.
|
||||
|
||||
``mode``
|
||||
String: control the method used to output color. One of ``auto``, ``ansi``,
|
||||
``win32``, ``terminfo`` or ``debug``. In auto mode the color extension will
|
||||
use ANSI mode by default (or win32 mode on Windows) if it detects a
|
||||
terminal. Any invalid value will disable color.
|
||||
|
||||
``pagermode``
|
||||
String: optinal override of ``color.mode`` used with pager (from the pager
|
||||
extensions).
|
||||
|
||||
On some systems, terminfo mode may cause problems when using
|
||||
color with the pager extension and less -R. less with the -R option
|
||||
will only display ECMA-48 color codes, and terminfo mode may sometimes
|
||||
emit codes that less doesn't understand. You can work around this by
|
||||
either using ansi mode (or auto mode), or by using less -r (which will
|
||||
pass through all terminal control codes, not just color control
|
||||
codes).
|
||||
|
||||
On some systems (such as MSYS in Windows), the terminal may support
|
||||
a different color mode than the pager (activated via the "pager"
|
||||
extension).
|
||||
|
||||
``committemplate``
|
||||
------------------
|
||||
@ -1797,6 +1824,13 @@ User interface controls.
|
||||
|
||||
By default, the first bundle advertised by the server is used.
|
||||
|
||||
``color``
|
||||
String: when to use to colorize output. possible value are auto, always,
|
||||
never, or debug (default: never). 'auto' will use color whenever it seems
|
||||
possible. See :hg:`help color` for details.
|
||||
|
||||
(in addition a boolean can be used in place always/never)
|
||||
|
||||
``commitsubrepos``
|
||||
Whether to commit modified subrepositories when committing the
|
||||
parent repository. If False and one subrepository has uncommitted
|
||||
|
||||
@ -533,7 +533,7 @@ hide outer repo
|
||||
-q --quiet suppress output
|
||||
-v --verbose enable additional output
|
||||
--color TYPE when to colorize (boolean, always, auto, never, or
|
||||
debug) (EXPERIMENTAL)
|
||||
debug)
|
||||
--config CONFIG [+] set/override config option (use 'section.name=value')
|
||||
--debug enable debugging output
|
||||
--debugger start debugger
|
||||
@ -572,7 +572,7 @@ hide outer repo
|
||||
-q --quiet suppress output
|
||||
-v --verbose enable additional output
|
||||
--color TYPE when to colorize (boolean, always, auto, never, or
|
||||
debug) (EXPERIMENTAL)
|
||||
debug)
|
||||
--config CONFIG [+] set/override config option (use 'section.name=value')
|
||||
--debug enable debugging output
|
||||
--debugger start debugger
|
||||
@ -854,7 +854,7 @@ extension help itself
|
||||
-q --quiet suppress output
|
||||
-v --verbose enable additional output
|
||||
--color TYPE when to colorize (boolean, always, auto, never, or
|
||||
debug) (EXPERIMENTAL)
|
||||
debug)
|
||||
--config CONFIG [+] set/override config option (use 'section.name=value')
|
||||
--debug enable debugging output
|
||||
--debugger start debugger
|
||||
@ -891,7 +891,7 @@ Make sure that single '-v' option shows help and built-ins only for 'dodo' comma
|
||||
-q --quiet suppress output
|
||||
-v --verbose enable additional output
|
||||
--color TYPE when to colorize (boolean, always, auto, never, or
|
||||
debug) (EXPERIMENTAL)
|
||||
debug)
|
||||
--config CONFIG [+] set/override config option (use 'section.name=value')
|
||||
--debug enable debugging output
|
||||
--debugger start debugger
|
||||
@ -966,7 +966,7 @@ help options '-v' and '-v -e' should be equivalent
|
||||
-q --quiet suppress output
|
||||
-v --verbose enable additional output
|
||||
--color TYPE when to colorize (boolean, always, auto, never, or
|
||||
debug) (EXPERIMENTAL)
|
||||
debug)
|
||||
--config CONFIG [+] set/override config option (use 'section.name=value')
|
||||
--debug enable debugging output
|
||||
--debugger start debugger
|
||||
@ -1002,7 +1002,7 @@ help options '-v' and '-v -e' should be equivalent
|
||||
-q --quiet suppress output
|
||||
-v --verbose enable additional output
|
||||
--color TYPE when to colorize (boolean, always, auto, never, or
|
||||
debug) (EXPERIMENTAL)
|
||||
debug)
|
||||
--config CONFIG [+] set/override config option (use 'section.name=value')
|
||||
--debug enable debugging output
|
||||
--debugger start debugger
|
||||
|
||||
@ -250,7 +250,6 @@ Test extension help:
|
||||
censor erase file content at a given revision
|
||||
churn command to display statistics about repository history
|
||||
clonebundles advertise pre-generated bundles to seed clones
|
||||
color colorize output from some commands
|
||||
convert import revisions from foreign VCS repositories into
|
||||
Mercurial
|
||||
eol automatically manage newlines in repository files
|
||||
@ -317,7 +316,7 @@ Test short command list with verbose option
|
||||
-q --quiet suppress output
|
||||
-v --verbose enable additional output
|
||||
--color TYPE when to colorize (boolean, always, auto, never, or
|
||||
debug) (EXPERIMENTAL)
|
||||
debug)
|
||||
--config CONFIG [+] set/override config option (use 'section.name=value')
|
||||
--debug enable debugging output
|
||||
--debugger start debugger
|
||||
@ -417,7 +416,7 @@ Verbose help for add
|
||||
-q --quiet suppress output
|
||||
-v --verbose enable additional output
|
||||
--color TYPE when to colorize (boolean, always, auto, never, or
|
||||
debug) (EXPERIMENTAL)
|
||||
debug)
|
||||
--config CONFIG [+] set/override config option (use 'section.name=value')
|
||||
--debug enable debugging output
|
||||
--debugger start debugger
|
||||
@ -2522,7 +2521,7 @@ Dish up an empty repo; serve it cold.
|
||||
<td>enable additional output</td></tr>
|
||||
<tr><td></td>
|
||||
<td>--color TYPE</td>
|
||||
<td>when to colorize (boolean, always, auto, never, or debug) (EXPERIMENTAL)</td></tr>
|
||||
<td>when to colorize (boolean, always, auto, never, or debug)</td></tr>
|
||||
<tr><td></td>
|
||||
<td>--config CONFIG [+]</td>
|
||||
<td>set/override config option (use 'section.name=value')</td></tr>
|
||||
@ -2723,7 +2722,7 @@ Dish up an empty repo; serve it cold.
|
||||
<td>enable additional output</td></tr>
|
||||
<tr><td></td>
|
||||
<td>--color TYPE</td>
|
||||
<td>when to colorize (boolean, always, auto, never, or debug) (EXPERIMENTAL)</td></tr>
|
||||
<td>when to colorize (boolean, always, auto, never, or debug)</td></tr>
|
||||
<tr><td></td>
|
||||
<td>--config CONFIG [+]</td>
|
||||
<td>set/override config option (use 'section.name=value')</td></tr>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user