This patch adds the necessary information regarding the usage of derived
perf events to perfevent.conf.5 man page.
Signed-off-by: Hemant Kumar <hemant@xxxxxxxxxxxxxxxxxx>
---
man/man5/perfevent.conf.5 | 19 ++++++++++++++++++-
1 file changed, 18 insertions(+), 1 deletion(-)
diff --git a/man/man5/perfevent.conf.5 b/man/man5/perfevent.conf.5
index 0c43919..5e068fa 100644
--- a/man/man5/perfevent.conf.5
+++ b/man/man5/perfevent.conf.5
@@ -31,7 +31,9 @@ configured events. If multiple PMUs are available, the
perfevent PMDA uses the order of the entries in the configuration file to
determine which PMU settings to use. The entries at the top of the
configuration file have higher precedence. Only one PMU configuration setting
-is used.
+is used. The configuration file may also contain perf derived events. A derived
+event has a list of events which must be listed as base events. The values for
+the counters in the derived events are aggregated and displayed.
.SH FILE FORMAT
The file consists of one or more groups of PMUs and the events that go with
them.
.PP
@@ -47,6 +49,21 @@ The PMU identification string is enclosed in brackets and
one or more events are
.B ...
.RE
.PP
+For derived events, the derived perf event is enclosed in brackets along with
+:derived as a suffix. Note that the EVENT_NAME listed under derived event must
+be present as a base event in the configuration file. And, all the events under
+a particular derived perf event must have the same CPU_OPTION. The syntax is :
+.PP
+.RS
+.B [event:derived]
+.RE
+.RS
+.B EVENT_NAME [CPU_OPTION]
+.RE
+.RS
+.B ...
+.RE
+.PP
The available event cpu options are as follows:
.TP
.B cpu
--
1.9.3
|