Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 7d685243 authored by Taeung Song's avatar Taeung Song Committed by Arnaldo Carvalho de Melo
Browse files

perf config: Add initial man page 



Add perf-config document to describe the perf configuration and a
'list’ subcommand.

Signed-off-by: default avatarTaeung Song <treeze.taeung@gmail.com>
Cc: Jiri Olsa <jolsa@redhat.com>
Cc: Namhyung Kim <namhyung@kernel.org>
Link: http://lkml.kernel.org/r/63AD9B57-7B8C-46F8-8F18-0FFEB9A6A1BC@gmail.com


Signed-off-by: default avatarArnaldo Carvalho de Melo <acme@redhat.com>
parent 30862f2c

tools/perf/Documentation/perf-config.txt

0 → 100644
+103 −0
Original line number Diff line number Diff line 
perf-config(1)

==============



NAME

----

perf-config - Get and set variables in a configuration file.



SYNOPSIS

--------

[verse]

'perf config' -l | --list



DESCRIPTION

-----------

You can manage variables in a configuration file with this command.



OPTIONS

-------



-l::

--list::

	Show current config variables, name and value, for all sections.



CONFIGURATION FILE

------------------



The perf configuration file contains many variables to change various

aspects of each of its tools, including output, disk usage, etc.

The '$HOME/.perfconfig' file is used to store a per-user configuration.

The file '$(sysconfdir)/perfconfig' can be used to

store a system-wide default configuration.



Syntax

~~~~~~



The file consist of sections. A section starts with its name

surrounded by square brackets and continues till the next section

begins. Each variable must be in a section, and have the form

'name = value', for example:



	[section]

		name1 = value1

		name2 = value2



Section names are case sensitive and can contain any characters except

newline (double quote `"` and backslash have to be escaped as `\"` and `\\`,

respectively). Section headers can't span multiple lines.



Example

~~~~~~~



Given a $HOME/.perfconfig like this:



#

# This is the config file, and

# a '#' and ';' character indicates a comment

#



	[colors]

		# Color variables

		top = red, default

		medium = green, default

		normal = lightgray, default

		selected = white, lightgray

		code = blue, default

		addr = magenta, default

		root = white, blue



	[tui]

		# Defaults if linked with libslang

		report = on

		annotate = on

		top = on



	[buildid]

		# Default, disable using /dev/null

		dir = ~/.debug



	[annotate]

		# Defaults

		hide_src_code = false

		use_offset = true

		jump_arrows = true

		show_nr_jumps = false



	[help]

		# Format can be man, info, web or html

		format = man

		autocorrect = 0



	[ui]

		show-headers = true



	[call-graph]

		# fp (framepointer), dwarf

		record-mode = fp

		print-type = graph

		order = caller

		sort-key = function



SEE ALSO

--------

linkperf:perf[1]