Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]


Groups > linux.kernel > #1271735

Re: [PATCH v11 02/24] perf tools: Add perf-config document

From Namhyung Kim <namhyung@kernel.org>
Newsgroups linux.kernel
Subject Re: [PATCH v11 02/24] perf tools: Add perf-config document
Date 2015-11-18 00:20 +0100
Message-ID <qvXHz-3ak-7@gated-at.bofh.it> (permalink)
References <qvTkC-f2-7@gated-at.bofh.it> <qvTui-is-15@gated-at.bofh.it>
Organization linux.* mail to news gateway

Show all headers | View raw


On Tue, Nov 17, 2015 at 10:53:22PM +0900, Taeung Song wrote:
> Add perf-config document to describe the perf configuration
> and a subcommand 'list'.
> 
> Cc: Jiri Olsa <jolsa@redhat.com>
> Signed-off-by: Taeung Song <treeze.taeung@gmail.com>

Acked-by: Namhyung Kim <namhyung@kernel.org>

Thanks,
Namhyung


> ---
>  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 0000000..dfdab9c
> --- /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]
> -- 
> 1.9.1
> 
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/

Back to linux.kernel | Previous | NextPrevious in thread | Next in thread | Find similar | Unroll thread


Thread

[PATCH v11 01/24] perf tools: Add 'perf-config' command Taeung Song <treeze.taeung@gmail.com> - 2015-11-17 19:40 +0100
  [PATCH v11 22/24] perf config: Add 'set' feature Taeung Song <treeze.taeung@gmail.com> - 2015-11-17 19:40 +0100
  [PATCH v11 14/24] perf config: Document 'pager.<subcommand>' variables in man page Taeung Song <treeze.taeung@gmail.com> - 2015-11-17 19:40 +0100
    Re: [PATCH v11 14/24] perf config: Document 'pager.<subcommand>'  variables in man page Namhyung Kim <namhyung@kernel.org> - 2015-11-18 06:10 +0100
  [PATCH v11 19/24] perf config: Add a option 'skel' to perf-config Taeung Song <treeze.taeung@gmail.com> - 2015-11-17 19:40 +0100
  [PATCH v11 13/24] perf config: Document 'man.viewer' variable in man page Taeung Song <treeze.taeung@gmail.com> - 2015-11-17 19:40 +0100
    Re: [PATCH v11 13/24] perf config: Document 'man.viewer' variable in  man page Namhyung Kim <namhyung@kernel.org> - 2015-11-18 06:00 +0100
  [PATCH v11 07/24] perf config: Document variables for 'help' section in man page Taeung Song <treeze.taeung@gmail.com> - 2015-11-17 19:40 +0100
    Re: [PATCH v11 07/24] perf config: Document variables for 'help'  section in man page Namhyung Kim <namhyung@kernel.org> - 2015-11-18 01:50 +0100
  [PATCH v11 08/24] perf config: Document 'hist.percentage' variable in man page Taeung Song <treeze.taeung@gmail.com> - 2015-11-17 19:40 +0100
    Re: [PATCH v11 08/24] perf config: Document 'hist.percentage'  variable in man page Namhyung Kim <namhyung@kernel.org> - 2015-11-18 02:00 +0100
  [PATCH v11 18/24] perf config: Add 'list-all' option to perf-config Taeung Song <treeze.taeung@gmail.com> - 2015-11-17 19:40 +0100
  [PATCH v11 17/24] perf config: Collect configs to handle config variables Taeung Song <treeze.taeung@gmail.com> - 2015-11-17 19:40 +0100
    Re: [PATCH v11 17/24] perf config: Collect configs to handle config  variables Namhyung Kim <namhyung@kernel.org> - 2015-11-18 06:20 +0100
  [PATCH v11 16/24] perf config: Add '--system' and '--user' options to select which config file is used Taeung Song <treeze.taeung@gmail.com> - 2015-11-17 19:40 +0100
    Re: [PATCH v11 16/24] perf config: Add '--system' and '--user'  options to select which config file is used Namhyung Kim <namhyung@kernel.org> - 2015-11-18 06:20 +0100
  [PATCH v11 12/24] perf config: Document 'top.chidren' variable in man page Taeung Song <treeze.taeung@gmail.com> - 2015-11-17 19:40 +0100
    Re: [PATCH v11 12/24] perf config: Document 'top.chidren' variable  in man page Namhyung Kim <namhyung@kernel.org> - 2015-11-18 04:10 +0100
  [PATCH v11 11/24] perf config: Document variables for 'report' section in man page Taeung Song <treeze.taeung@gmail.com> - 2015-11-17 19:40 +0100
    Re: [PATCH v11 11/24] perf config: Document variables for 'report'  section in man page Namhyung Kim <namhyung@kernel.org> - 2015-11-18 04:10 +0100
  [PATCH v11 24/24] perf config: Add a option 'remove' to perf-config Taeung Song <treeze.taeung@gmail.com> - 2015-11-17 19:40 +0100
  [PATCH v11 23/24] perf config: normalize a value depending on default type of it Taeung Song <treeze.taeung@gmail.com> - 2015-11-17 19:40 +0100
  [PATCH v11 04/24] perf config: Document variables for 'tui' and 'gtk' sections in man page Taeung Song <treeze.taeung@gmail.com> - 2015-11-17 19:40 +0100
    Re: [PATCH v11 04/24] perf config: Document variables for 'tui' and  'gtk' sections in man page Namhyung Kim <namhyung@kernel.org> - 2015-11-18 01:10 +0100
  [PATCH v11 06/24] perf config: Document variables for 'annotate' section in man page Taeung Song <treeze.taeung@gmail.com> - 2015-11-17 19:40 +0100
    Re: [PATCH v11 06/24] perf config: Document variables for 'annotate'  section in man page Namhyung Kim <namhyung@kernel.org> - 2015-11-18 01:30 +0100
  [PATCH v11 10/24] perf config: Document variables for 'call-graph' section in man page Taeung Song <treeze.taeung@gmail.com> - 2015-11-17 19:40 +0100
    Re: [PATCH v11 10/24] perf config: Document variables for  'call-graph' section in man page Namhyung Kim <namhyung@kernel.org> - 2015-11-18 04:00 +0100
      Re: [PATCH v11 10/24] perf config: Document variables for 'call-graph' section in man page Taeung Song <treeze.taeung@gmail.com> - 2015-11-30 02:50 +0100
        Re: [PATCH v11 10/24] perf config: Document variables for  'call-graph' section in man page Namhyung Kim <namhyung@kernel.org> - 2015-11-30 06:10 +0100
  [PATCH v11 20/24] perf config: Add --verbose option for showing config description Taeung Song <treeze.taeung@gmail.com> - 2015-11-17 19:40 +0100
  [PATCH v11 03/24] perf config: Document variables for 'color' section in man page Taeung Song <treeze.taeung@gmail.com> - 2015-11-17 19:50 +0100
    Re: [PATCH v11 03/24] perf config: Document variables for 'color'  section in man page Namhyung Kim <namhyung@kernel.org> - 2015-11-18 00:50 +0100
  [PATCH v11 02/24] perf tools: Add perf-config document Taeung Song <treeze.taeung@gmail.com> - 2015-11-17 19:50 +0100
    Re: [PATCH v11 02/24] perf tools: Add perf-config document Namhyung Kim <namhyung@kernel.org> - 2015-11-18 00:20 +0100
      Re: [PATCH v11 02/24] perf tools: Add perf-config document Arnaldo Carvalho de Melo <acme@kernel.org> - 2015-11-19 20:30 +0100
        [PATCH v11 RESEND 02/24] perf tools: Add perf-config document Taeung Song <treeze.taeung@gmail.com> - 2015-11-22 11:20 +0100
          Re: [PATCH v11 RESEND 02/24] perf tools: Add perf-config document Arnaldo Carvalho de Melo <arnaldo.melo@gmail.com> - 2015-11-23 15:20 +0100
          [tip:perf/core] perf config: Add initial man page tip-bot for Taeung Song <tipbot@zytor.com> - 2015-11-26 09:30 +0100
        Re: [PATCH v11 02/24] perf tools: Add perf-config document Taeung Song <treeze.taeung@gmail.com> - 2015-11-22 11:20 +0100
  [PATCH v11 09/24] perf config: Document 'ui.show-headers' variable in man page Taeung Song <treeze.taeung@gmail.com> - 2015-11-17 19:50 +0100
    Re: [PATCH v11 09/24] perf config: Document 'ui.show-headers'  variable in man page Namhyung Kim <namhyung@kernel.org> - 2015-11-18 02:10 +0100
  [PATCH v11 05/24] perf config: Document 'buildid.dir' variable in man page Taeung Song <treeze.taeung@gmail.com> - 2015-11-17 19:50 +0100
    Re: [PATCH v11 05/24] perf config: Document 'buildid.dir' variable  in man page Namhyung Kim <namhyung@kernel.org> - 2015-11-18 01:10 +0100
  Re: [PATCH v11 01/24] perf tools: Add 'perf-config' command Namhyung Kim <namhyung@gmail.com> - 2015-11-17 23:40 +0100
  [tip:perf/core] perf tools: Add 'perf config' command tip-bot for Taeung Song <tipbot@zytor.com> - 2015-11-26 09:30 +0100

csiph-web