mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Ramkumar Ramachandra <artagnon@gmail.com>
To: LKML <linux-kernel@vger.kernel.org>
Cc: Ingo Molnar <mingo@kernel.org>, Namhyung Kim <namhyung@gmail.com>,
	Arnaldo Carvalho de Melo <acme@ghostprotocols.net>,
	David Ahern <dsahern@gmail.com>
Subject: [PATCH] perf tool: add example to perf-trace documentation
Date: Wed,  2 Oct 2013 14:25:18 +0530	[thread overview]
Message-ID: <1380704118-12377-1-git-send-email-artagnon@gmail.com> (raw)

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@kernel.org>
Cc: Namhyung Kim <namhyung@gmail.com>
Cc: Arnaldo Carvalho de Melo <acme@ghostprotocols.net>
Cc: David Ahern <dsahern@gmail.com>
Signed-off-by: Ramkumar Ramachandra <artagnon@gmail.com>
---
 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


                 reply	other threads:[~2013-10-02  9:02 UTC|newest]

Thread overview: [no followups] expand[flat|nested]  mbox.gz  Atom feed

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1380704118-12377-1-git-send-email-artagnon@gmail.com \
    --to=artagnon@gmail.com \
    --cc=acme@ghostprotocols.net \
    --cc=dsahern@gmail.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mingo@kernel.org \
    --cc=namhyung@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

all inboxes | Powered by JetHome®