Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

perf record/stat: Explicitly call out event modifiers in the documentation

Event modifiers are not mentioned in the perf record or perf stat
manpages. Add them to orient new users more effectively by pointing
them to the perf list manpage for details.

Fixes: 2055fdaf8703 ("perf list: Document precise event sampling for AMD IBS")
Signed-off-by: Kim Phillips <kim.phillips@amd.com>
Cc: Adrian Hunter <adrian.hunter@intel.com>
Cc: Alexander Shishkin <alexander.shishkin@linux.intel.com>
Cc: Alexey Budankov <alexey.budankov@linux.intel.com>
Cc: Ian Rogers <irogers@google.com>
Cc: Jin Yao <yao.jin@linux.intel.com>
Cc: Jiri Olsa <jolsa@redhat.com>
Cc: Mark Rutland <mark.rutland@arm.com>
Cc: Namhyung Kim <namhyung@kernel.org>
Cc: Paul Clarke <pc@us.ibm.com>
Cc: Peter Zijlstra <peterz@infradead.org>
Cc: Stephane Eranian <eranian@google.com>
Cc: Tony Jones <tonyj@suse.de>
Cc: stable@vger.kernel.org
Link: http://lore.kernel.org/lkml/20200901215853.276234-1-kim.phillips@amd.com
Signed-off-by: Arnaldo Carvalho de Melo <acme@redhat.com>

authored by

Kim Phillips and committed by
Arnaldo Carvalho de Melo
e48a73a3 e4d71f79

+8
+4
tools/perf/Documentation/perf-record.txt
··· 33 33 - a raw PMU event (eventsel+umask) in the form of rNNN where NNN is a 34 34 hexadecimal event descriptor. 35 35 36 + - a symbolic or raw PMU event followed by an optional colon 37 + and a list of event modifiers, e.g., cpu-cycles:p. See the 38 + linkperf:perf-list[1] man page for details on event modifiers. 39 + 36 40 - a symbolically formed PMU event like 'pmu/param1=0x3,param2/' where 37 41 'param1', 'param2', etc are defined as formats for the PMU in 38 42 /sys/bus/event_source/devices/<pmu>/format/*.
+4
tools/perf/Documentation/perf-stat.txt
··· 39 39 - a raw PMU event (eventsel+umask) in the form of rNNN where NNN is a 40 40 hexadecimal event descriptor. 41 41 42 + - a symbolic or raw PMU event followed by an optional colon 43 + and a list of event modifiers, e.g., cpu-cycles:p. See the 44 + linkperf:perf-list[1] man page for details on event modifiers. 45 + 42 46 - a symbolically formed event like 'pmu/param1=0x3,param2/' where 43 47 param1 and param2 are defined as formats for the PMU in 44 48 /sys/bus/event_source/devices/<pmu>/format/*