Skip to contentSkip to conversation

perf record: Document --group option

PATCH New Namhyung Kim 2 participants 2 messages Mar 2, 2015 – Mar 3, 2015 perf events

lore
Share & tools
lore

Namhyung Kim

author maintainer
#0 lore raw

PATCH 1/1 perf record: Document --group option

The 'perf record --group' option lacks documentation and confuses users. As -e/--event option already supports group spec, it should not be used anymore.

Also add a short description of event group itself.

---
 tools/perf/Documentation/perf-record.txt | 9 +++++++++
 1 file changed, 9 insertions(+)
tools/perf/Documentation/perf-record.txt +9 -0
index cae75c11120f..f989beafd52a 100644
@@ -55,6 +55,11 @@ OPTIONS
           If you want to profile write accesses in [0x1000~1008), just set
           'mem:0x1000/8:w'.
 
+	- a group of events surrounded by a pair of brace ("{event1,event2,...}").
+	  Each event is separated by commas and the group should be quoted to
+	  prevent the shell interpretation.  You also need to use --group on
+	  "perf report" to view group events together.
+
 --filter=<filter>::
         Event filter.
 
@@ -107,6 +112,10 @@ OPTIONS
 	specification with appended unit character - B/K/M/G. The
 	size is rounded up to have nearest pages power of two value.
 
+--group::
+	Put all events in a single event group.  This precedes the --event
+	option and remains only for backward compatibility.  See --event.
+
 -g::
 	Enables call-graph (stack chain/backtrace) recording.
 
Signature · 1 line
2.2.2
#1 lore raw
perf record: Document --group option
Commit-ID:  9a75606ca06d94aab1ed0dbe96935e3f89dfb81c
Gitweb:     http://git.kernel.org/tip/9a75606ca06d94aab1ed0dbe96935e3f89dfb81c
Author:     Namhyung Kim <[email protected]>
AuthorDate: Mon, 2 Mar 2015 12:13:33 +0900
Committer:  Arnaldo Carvalho de Melo <[email protected]>
CommitDate: Mon, 2 Mar 2015 12:04:45 -0300

perf record: Document --group option

The 'perf record --group' option lacks documentation and confuses users. As -e/--event option already supports group spec, it should not be used anymore.

Also add a short description of event group itself.

---
 tools/perf/Documentation/perf-record.txt | 9 +++++++++
 1 file changed, 9 insertions(+)
tools/perf/Documentation/perf-record.txt +9 -0
index 4d66894..355c4f5 100644
@@ -55,6 +55,11 @@ OPTIONS
           If you want to profile write accesses in [0x1000~1008), just set
           'mem:0x1000/8:w'.
 
+	- a group of events surrounded by a pair of brace ("{event1,event2,...}").
+	  Each event is separated by commas and the group should be quoted to
+	  prevent the shell interpretation.  You also need to use --group on
+	  "perf report" to view group events together.
+
 --filter=<filter>::
         Event filter.
 
@@ -104,6 +109,10 @@ OPTIONS
 	specification with appended unit character - B/K/M/G. The
 	size is rounded up to have nearest pages power of two value.
 
+--group::
+	Put all events in a single event group.  This precedes the --event
+	option and remains only for backward compatibility.  See --event.
+
 -g::
 	Enables call-graph (stack chain/backtrace) recording.