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.

Reported-by: Stephane Eranian <eran...@google.com>
Signed-off-by: Namhyung Kim <namhy...@kernel.org>
---
 tools/perf/Documentation/perf-record.txt | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/tools/perf/Documentation/perf-record.txt 
b/tools/perf/Documentation/perf-record.txt
index cae75c11120f..f989beafd52a 100644
--- a/tools/perf/Documentation/perf-record.txt
+++ b/tools/perf/Documentation/perf-record.txt
@@ -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.
 
-- 
2.2.2

--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majord...@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/

Reply via email to