Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 6cadd1e2 authored by Kim Phillips's avatar Kim Phillips Committed by Greg Kroah-Hartman
Browse files

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



commit e48a73a312ebf19cc3d72aa74985db25c30757c1 upstream.

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: 2055fdaf ("perf list: Document precise event sampling for AMD IBS")
Signed-off-by: default avatarKim 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: default avatarArnaldo Carvalho de Melo <acme@redhat.com>
Signed-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
parent 4bae1afe

tools/perf/Documentation/perf-record.txt

+4 −0
Original line number Diff line number Diff line
@@ -33,6 +33,10 @@ OPTIONS 
        - a raw PMU event (eventsel+umask) in the form of rNNN where NNN is a

	  hexadecimal event descriptor.



        - a symbolic or raw PMU event followed by an optional colon

	  and a list of event modifiers, e.g., cpu-cycles:p.  See the

	  linkperf:perf-list[1] man page for details on event modifiers.



	- a symbolically formed PMU event like 'pmu/param1=0x3,param2/' where

	  'param1', 'param2', etc are defined as formats for the PMU in

	  /sys/bus/event_source/devices/<pmu>/format/*.

tools/perf/Documentation/perf-stat.txt

+4 −0
Original line number Diff line number Diff line
@@ -39,6 +39,10 @@ report:: 
	- a raw PMU event (eventsel+umask) in the form of rNNN where NNN is a

	  hexadecimal event descriptor.



        - a symbolic or raw PMU event followed by an optional colon

	  and a list of event modifiers, e.g., cpu-cycles:p.  See the

	  linkperf:perf-list[1] man page for details on event modifiers.



	- a symbolically formed event like 'pmu/param1=0x3,param2/' where

	  param1 and param2 are defined as formats for the PMU in

	  /sys/bus/event_source/devices/<pmu>/format/*