[PATCH] perf, tools: Improve documentation of event parameters for perf record

From: Andi Kleen
Date: Thu Oct 13 2016 - 13:58:41 EST

From: Andi Kleen <ak@xxxxxxxxxxxxxxx>

- Some editing (params -> parameters)
- Point to the now more complete list of parameters in the perf list

Signed-off-by: Andi Kleen <ak@xxxxxxxxxxxxxxx>
tools/perf/Documentation/perf-record.txt | 9 ++++++---
1 file changed, 6 insertions(+), 3 deletions(-)

diff --git a/tools/perf/Documentation/perf-record.txt b/tools/perf/Documentation/perf-record.txt
index 92335193dc33..27fc3617c6a4 100644
--- a/tools/perf/Documentation/perf-record.txt
+++ b/tools/perf/Documentation/perf-record.txt
@@ -45,9 +45,9 @@ OPTIONS
param1 and param2 are defined as formats for the PMU in:

- 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