diff options
Diffstat (limited to 'tools/perf/Documentation/perf-trace.txt')
-rw-r--r-- | tools/perf/Documentation/perf-trace.txt | 15 |
1 files changed, 13 insertions, 2 deletions
diff --git a/tools/perf/Documentation/perf-trace.txt b/tools/perf/Documentation/perf-trace.txt index 60e5900da483..8879299cd9df 100644 --- a/tools/perf/Documentation/perf-trace.txt +++ b/tools/perf/Documentation/perf-trace.txt | |||
@@ -19,6 +19,11 @@ There are several variants of perf trace: | |||
19 | 'perf trace' to see a detailed trace of the workload that was | 19 | 'perf trace' to see a detailed trace of the workload that was |
20 | recorded. | 20 | recorded. |
21 | 21 | ||
22 | You can also run a set of pre-canned scripts that aggregate and | ||
23 | summarize the raw trace data in various ways (the list of scripts is | ||
24 | available via 'perf trace -l'). The following variants allow you to | ||
25 | record and run those scripts: | ||
26 | |||
22 | 'perf trace record <script>' to record the events required for 'perf | 27 | 'perf trace record <script>' to record the events required for 'perf |
23 | trace report'. <script> is the name displayed in the output of | 28 | trace report'. <script> is the name displayed in the output of |
24 | 'perf trace --list' i.e. the actual script name minus any language | 29 | 'perf trace --list' i.e. the actual script name minus any language |
@@ -31,6 +36,9 @@ There are several variants of perf trace: | |||
31 | record <script>' is used and should be present for this command to | 36 | record <script>' is used and should be present for this command to |
32 | succeed. | 37 | succeed. |
33 | 38 | ||
39 | See the 'SEE ALSO' section for links to language-specific | ||
40 | information on how to write and run your own trace scripts. | ||
41 | |||
34 | OPTIONS | 42 | OPTIONS |
35 | ------- | 43 | ------- |
36 | -D:: | 44 | -D:: |
@@ -45,9 +53,11 @@ OPTIONS | |||
45 | --list=:: | 53 | --list=:: |
46 | Display a list of available trace scripts. | 54 | Display a list of available trace scripts. |
47 | 55 | ||
48 | -s:: | 56 | -s ['lang']:: |
49 | --script=:: | 57 | --script=:: |
50 | Process trace data with the given script ([lang]:script[.ext]). | 58 | Process trace data with the given script ([lang]:script[.ext]). |
59 | If the string 'lang' is specified in place of a script name, a | ||
60 | list of supported languages will be displayed instead. | ||
51 | 61 | ||
52 | -g:: | 62 | -g:: |
53 | --gen-script=:: | 63 | --gen-script=:: |
@@ -56,4 +66,5 @@ OPTIONS | |||
56 | 66 | ||
57 | SEE ALSO | 67 | SEE ALSO |
58 | -------- | 68 | -------- |
59 | linkperf:perf-record[1], linkperf:perf-trace-perl[1] | 69 | linkperf:perf-record[1], linkperf:perf-trace-perl[1], |
70 | linkperf:perf-trace-python[1] | ||