lkml.org 
[lkml]   [2015]   [Nov]   [23]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
    /
    Date
    From
    SubjectRe: [PATCH v11 RESEND 02/24] perf tools: Add perf-config document
    Em Sun, Nov 22, 2015 at 07:11:56PM +0900, Taeung Song escreveu:
    > Add perf-config document to describe the perf configuration
    > and a subcommand 'list’.

    Worked this time, applied, will continue processing the other patches
    soon.

    - Arnaldo

    > 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 | 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..b9ca1e3
    > --- /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


    \
     
     \ /
      Last update: 2015-11-23 15:41    [W:3.212 / U:0.164 seconds]
    ©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site