Skip to content

Commit

Permalink
perf trace/scripting: Update Documentation
Browse files Browse the repository at this point in the history
Update the perf-trace page with new and missing options and
remove some unused ones.

Signed-off-by: Tom Zanussi <tzanussi@gmail.com>
Cc: fweisbec@gmail.com
Cc: rostedt@goodmis.org
LKML-Reference: <1260867220-15699-7-git-send-email-tzanussi@gmail.com>
Signed-off-by: Ingo Molnar <mingo@elte.hu>
  • Loading branch information
Tom Zanussi authored and Ingo Molnar committed Dec 15, 2009
1 parent 3875294 commit a600512
Showing 1 changed file with 26 additions and 1 deletion.
27 changes: 26 additions & 1 deletion tools/perf/Documentation/perf-trace.txt
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,43 @@ perf-trace - Read perf.data (created by perf record) and display trace output
SYNOPSIS
--------
[verse]
'perf trace' [-i <file> | --input=file] symbol_name
'perf trace' {record <script> | report <script> [args] }

DESCRIPTION
-----------
This command reads the input file and displays the trace recorded.

There are several variants of perf trace:

'perf trace' to see a detailed trace of the workload that was
recorded.

'perf trace record <script>' to record the events required for 'perf
trace report'. <script> is the name displayed in the output of
'perf trace --list' i.e. the actual script name minus any language
extension.

'perf trace report <script>' to run and display the results of
<script>. <script> is the name displayed in the output of 'perf
trace --list' i.e. the actual script name minus any language
extension. The perf.data output from a previous run of 'perf trace
record <script>' is used and should be present for this command to
succeed.

OPTIONS
-------
-D::
--dump-raw-trace=::
Display verbose dump of the trace data.

-L::
--Latency=::
Show latency attributes (irqs/preemption disabled, etc).

-l::
--list=::
Display a list of available trace scripts.

-s::
--script=::
Process trace data with the given script ([lang]:script[.ext]).
Expand Down

0 comments on commit a600512

Please sign in to comment.