perf record: Improve documentation of event parameters
authorAndi Kleen <ak@linux.intel.com>
Thu, 13 Oct 2016 17:57:13 +0000 (10:57 -0700)
committerArnaldo Carvalho de Melo <acme@redhat.com>
Mon, 24 Oct 2016 14:07:35 +0000 (11:07 -0300)
- Some editing (params -> parameters)
- Point to the now more complete list of parameters in the perf list
manpage.

Signed-off-by: Andi Kleen <ak@linux.intel.com>
Cc: Jiri Olsa <jolsa@kernel.org>
Link: http://lkml.kernel.org/r/1476381433-22959-1-git-send-email-andi@firstfloor.org
Signed-off-by: Arnaldo Carvalho de Melo <acme@redhat.com>
tools/perf/Documentation/perf-record.txt

index 92335193dc3382690a7f490437469d48c451e130..27fc3617c6a42066bf7a64bb2ace9961a350183b 100644 (file)
@@ -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