All of lore.kernel.org
 help / color / mirror / Atom feed
From: Arnaldo Carvalho de Melo <acme@kernel.org>
To: Ingo Molnar <mingo@kernel.org>
Cc: linux-kernel@vger.kernel.org,
	Taeung Song <treeze.taeung@gmail.com>,
	Jiri Olsa <jolsa@redhat.com>, Namhyung Kim <namhyung@kernel.org>,
	Arnaldo Carvalho de Melo <acme@redhat.com>
Subject: [PATCH 6/7] perf config: Add initial man page
Date: Mon, 23 Nov 2015 18:53:53 -0300	[thread overview]
Message-ID: <1448315634-13592-7-git-send-email-acme@kernel.org> (raw)
In-Reply-To: <1448315634-13592-1-git-send-email-acme@kernel.org>

From: Taeung Song <treeze.taeung@gmail.com>

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

Signed-off-by: Taeung 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: Arnaldo Carvalho de Melo <acme@redhat.com>
---
 tools/perf/Documentation/perf-config.txt | 103 +++++++++++++++++++++++++++++++
 1 file changed, 103 insertions(+)
 create mode 100644 tools/perf/Documentation/perf-config.txt

diff --git a/tools/perf/Documentation/perf-config.txt b/tools/perf/Documentation/perf-config.txt
new file mode 100644
index 000000000000..b9ca1e304158
--- /dev/null
+++ b/tools/perf/Documentation/perf-config.txt
@@ -0,0 +1,103 @@
+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]
-- 
2.1.0


  parent reply	other threads:[~2015-11-23 21:54 UTC|newest]

Thread overview: 20+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-11-23 21:53 [GIT PULL 0/7] perf/core improvements and fixes Arnaldo Carvalho de Melo
2015-11-23 21:53 ` [PATCH 1/7] perf callchain: Move initial entry call into get_entries function Arnaldo Carvalho de Melo
2015-11-23 21:53 ` [PATCH 2/7] perf callchain: Add order support for libunwind DWARF unwinder Arnaldo Carvalho de Melo
2015-11-23 21:53 ` [PATCH 3/7] perf test: Add callchain order setup for DWARF unwinder test Arnaldo Carvalho de Melo
2015-11-23 21:53 ` [PATCH 4/7] perf callchain: Add order support for libdw DWARF unwinder Arnaldo Carvalho de Melo
2015-11-23 21:53 ` [PATCH 5/7] perf tools: Add 'perf config' command Arnaldo Carvalho de Melo
2015-11-23 21:53 ` Arnaldo Carvalho de Melo [this message]
2015-11-23 21:53 ` [PATCH 7/7] perf callchain: Add missing parent_val initialization Arnaldo Carvalho de Melo
2015-11-24  8:10 ` [GIT PULL 0/7] perf/core improvements and fixes Ingo Molnar
2015-11-24  8:28   ` Jiri Olsa
2015-11-24  8:42     ` Ingo Molnar
2015-11-24  9:26       ` Jiri Olsa
2015-11-24  9:47         ` Jiri Olsa
2015-11-26 11:00           ` Ingo Molnar
2015-11-26 12:47             ` Jiri Olsa
2015-11-26  7:56         ` Ingo Molnar
2015-11-26  8:12           ` Ingo Molnar
2015-11-26  9:09             ` Jiri Olsa
2015-11-24 10:28   ` Jiri Olsa
2015-11-26  8:13   ` Ingo Molnar

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1448315634-13592-7-git-send-email-acme@kernel.org \
    --to=acme@kernel.org \
    --cc=acme@redhat.com \
    --cc=jolsa@redhat.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mingo@kernel.org \
    --cc=namhyung@kernel.org \
    --cc=treeze.taeung@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.