Re: [PATCH v11 03/24] perf config: Document variables for 'color' section in man page

[Namhyung Kim <namhyung@kernel.org>]

On Tue, Nov 17, 2015 at 10:53:23PM +0900, Taeung Song wrote:
> Explain 'color' section and its variables.
> 
> 'top', 'medium', 'normal', 'selected',
> 'code', 'addr' and 'root'.
> 
> Cc: Namhyung Kim <namhyung@kernel.org>
> Cc: Jiri Olsa <jolsa@redhat.com>
> Signed-off-by: Taeung Song <treeze.taeung@gmail.com>
> ---
>  tools/perf/Documentation/perf-config.txt | 44 ++++++++++++++++++++++++++++++++
>  1 file changed, 44 insertions(+)
> 
> diff --git a/tools/perf/Documentation/perf-config.txt b/tools/perf/Documentation/perf-config.txt
> index dfdab9c..84a982b 100644
> --- a/tools/perf/Documentation/perf-config.txt
> +++ b/tools/perf/Documentation/perf-config.txt
> @@ -98,6 +98,50 @@ Given a $HOME/.perfconfig like this:
>  	order = caller
>  	sort-key = function
>  
> +Variables
> +~~~~~~~~~
> +
> +colors.*::
> +	The variables for customizing the colors used in the output for the
> +	'report', 'top' and annotate in the TUI. They should specify the

The 'annotate' also needs to be surrounded by single quotes.


> +	background and foreground colors, separated by a comma, for example:

I think 'foreground and background' is better due to the order.


> +
> +		medium = green, lightgray
> +
> +	If you want to use the color configured for you terminal, just leave it
> +	as 'default', for example:
> +
> +		medium = default, lightgray
> +
> +	Available colors:
> +	red, green, default, black, blue, white, magenta, lightgray

I don't know about the libslang color scheme, but it seems that the
standard color names like 'yellow', 'cyan' and 'gray' are also
available.


> +
> +	colors.top::
> +		'top' means a overhead percentage which is more than 5%.
> +		And values of this variable specify percentage colors.
> +		Basic key values are foreground-color 'red' and
> +		background-color 'default'.
> +	colors.medium::
> +		'medium' means a overhead percentage which has more than 0.5%.
> +		Default values are 'green' and 'default'.
> +	colors.normal::
> +		'normal' means the rest of overhead percentages
> +		except 'top', 'medium', 'selected'.
> +		Default values are 'lightgray' and 'default'.
> +	colors.selected::
> +		This selects the colors for the current entry in a list of entries
> +		from sub-commands (top,report,annotate).
> +		Default values are 'white' and 'lightgray'.

Isn't it 'black' and 'lightgray'?


> +	colors.code::
> +		Colors for arrows and lines in jumps on  assembly code listings
> +		such as 'jns','jmp','jane',etc. Default values are 'blue', 'default'.

Hmm.. I thought this is for source code displayed with annotate
output, but it's only for jump arrows?  Maybe it's better to rename
this then..  Anyway it's a different problem.


> +	colors.addr::
> +		This selects colors for addresses from 'annotate'.
> +		Default values are 'magenta', 'default'.
> +	colors.root::
> +		Colors for headers in the output of a sub-command 'top'.

It also works for 'report'.

Thanks,
Namhyung


> +		Default values are 'white', 'blue'.
> +
>  SEE ALSO
>  --------
>  linkperf:perf[1]
> -- 
> 1.9.1
>