[PATCH] perf tool: add example to perf-trace documentation

[Ramkumar Ramachandra]

It's not clear that perf trace must be run as a privileged user, so
include an example demonstrating its usage with sudo. While at it,
update the synopsis to include options.

Cc: Ingo Molnar <mingo@xxxxxxxxxx>
Cc: Namhyung Kim <namhyung@xxxxxxxxx>
Cc: Arnaldo Carvalho de Melo <acme@xxxxxxxxxxxxxxxxxx>
Cc: David Ahern <dsahern@xxxxxxxxx>
Signed-off-by: Ramkumar Ramachandra <artagnon@xxxxxxxxx>
---
 tools/perf/Documentation/perf-trace.txt | 22 +++++++++++++++++++++-
 1 file changed, 21 insertions(+), 1 deletion(-)

diff --git a/tools/perf/Documentation/perf-trace.txt b/tools/perf/Documentation/perf-trace.txt
index daccd2c..4ad8950 100644
--- a/tools/perf/Documentation/perf-trace.txt
+++ b/tools/perf/Documentation/perf-trace.txt
@@ -8,7 +8,7 @@ perf-trace - strace inspired tool
 SYNOPSIS
 --------
 [verse]
-'perf trace'
+'perf trace' [<options>]
 
 DESCRIPTION
 -----------
@@ -78,6 +78,26 @@ the thread executes on the designated CPUs. Default is to monitor all CPUs.
 --input
 	Process events from a given perf data file.
 
+EXAMPLES
+--------
+
+$ sudo perf trace -a -e open
+
+   349.934 ( 0.012 ms): 832 open(filename: 0xc1a4f0, flags: RDONLY                                ) = 14
+   349.985 ( 0.004 ms): 832 open(filename: 0xb390e0, flags: RDONLY                                ) = 14
+   350.012 ( 0.004 ms): 832 open(filename: 0xa9c930, flags: RDONLY                                ) = 14
+   350.037 ( 0.003 ms): 832 open(filename: 0xc1a4f0, flags: RDONLY                                ) = 14
+   350.060 ( 0.003 ms): 832 open(filename: 0xb390e0, flags: RDONLY                                ) = 14
+   349.943 ( 0.010 ms): 9379 open(filename: 0x17d3080, flags: RDONLY                               ) = 19
+   350.213 ( 0.003 ms): 832 open(filename: 0xc93d10, flags: RDONLY                                ) = 14
+   350.307 ( 0.002 ms): 832 open(filename: 0xc64820, flags: RDONLY                                ) = 14
+   350.399 ( 0.002 ms): 832 open(filename: 0xea20f0, flags: RDONLY                                ) = 14
+   350.481 ( 0.002 ms): 832 open(filename: 0xbfb940, flags: RDONLY                                ) = 14
+   350.567 ( 0.002 ms): 832 open(filename: 0xb3edb0, flags: RDONLY                                ) = 14
+   850.345 ( 0.010 ms): 832 open(filename: 0xb72ba0, flags: RDONLY                                ) = 14
+   850.390 ( 0.003 ms): 832 open(filename: 0xfd8860, flags: RDONLY                                ) = 14
+   850.414 ( 0.003 ms): 832 open(filename: 0xee4740, flags: RDONLY                                ) = 14
+
 SEE ALSO
 --------
 linkperf:perf-record[1], linkperf:perf-script[1]
-- 
1.8.4.477.g5d89aa9

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