perf, tools: Improve documentation of event parameters for perf record
PATCH 1/1 perf, tools: Improve documentation of event parameters for perf record
From: Andi Kleen <[email protected]>
- Some editing (params -> parameters)
- Point to the now more complete list of parameters in the perf list manpage.
Signed-off-by Andi Kleen <[email protected]>
--- tools/perf/Documentation/perf-record.txt | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-)
tools/perf/Documentation/perf-record.txt +6 -3
@@ -45,9 +45,9 @@ OPTIONS param1 and param2 are defined as formats for the PMU in: /sys/bus/event_source/devices/<pmu>/format/* - There are also some params which are not defined in .../<pmu>/format/*. + There are also some parameters which are not defined in .../<pmu>/format/*. These params can be used to overload default config values per event. - Here is a list of the params. + Here are some common parameters: - 'period': Set event sampling period - 'freq': Set event sampling frequency - 'time': Disable/enable time stamping. Acceptable values are 1 for
@@ -57,8 +57,11 @@ OPTIONS FP mode, "dwarf" for DWARF mode, "lbr" for LBR mode and "no" for disable callgraph. - 'stack-size': user stack size for dwarf mode + + See the linkperf:perf-list[1] man page for more parameters. + Note: If user explicitly sets options which conflict with the params, - the value set by the params will be overridden. + the value set by the parameters will be overridden. Also not defined in .../<pmu>/format/* are PMU driver specific configuration parameters. Any configuration parameter preceded by
Signature · 1 line
2.5.5
tip-bot for Andi Kleen
merge bot[tip:perf/core] perf record: Improve documentation of event parameters
perf record: Improve documentation of event parameters
Commit-ID: 84ee74affccc93b02dee5a986dfe214f4eaa08d3 Gitweb: http://git.kernel.org/tip/84ee74affccc93b02dee5a986dfe214f4eaa08d3 Author: Andi Kleen <[email protected]> AuthorDate: Thu, 13 Oct 2016 10:57:13 -0700 Committer: Arnaldo Carvalho de Melo <[email protected]> CommitDate: Mon, 24 Oct 2016 11:07:35 -0300
perf record: Improve documentation of event parameters
- Some editing (params -> parameters)
- Point to the now more complete list of parameters in the perf list manpage.
Signed-off-by Andi Kleen <[email protected]>
Cc Jiri Olsa <[email protected]>
Signed-off-by Arnaldo Carvalho de Melo <[email protected]>
--- tools/perf/Documentation/perf-record.txt | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-)
tools/perf/Documentation/perf-record.txt +6 -3
@@ -45,9 +45,9 @@ OPTIONS param1 and param2 are defined as formats for the PMU in: /sys/bus/event_source/devices/<pmu>/format/* - There are also some params which are not defined in .../<pmu>/format/*. + There are also some parameters which are not defined in .../<pmu>/format/*. These params can be used to overload default config values per event. - Here is a list of the params. + Here are some common parameters: - 'period': Set event sampling period - 'freq': Set event sampling frequency - 'time': Disable/enable time stamping. Acceptable values are 1 for
@@ -57,8 +57,11 @@ OPTIONS FP mode, "dwarf" for DWARF mode, "lbr" for LBR mode and "no" for disable callgraph. - 'stack-size': user stack size for dwarf mode + + See the linkperf:perf-list[1] man page for more parameters. + Note: If user explicitly sets options which conflict with the params, - the value set by the params will be overridden. + the value set by the parameters will be overridden. Also not defined in .../<pmu>/format/* are PMU driver specific configuration parameters. Any configuration parameter preceded by