diff options
author | Adrian Hunter <adrian.hunter@intel.com> | 2016-06-16 15:51:26 -0400 |
---|---|---|
committer | Arnaldo Carvalho de Melo <acme@redhat.com> | 2016-06-21 12:18:33 -0400 |
commit | cbb0bba9f3526f23832385f9a47cf2a45fff7c05 (patch) | |
tree | b6da3e7a0f48b5e874de45bce76b60f46d12cab8 /tools | |
parent | b573d8028ee6125b353861bd1869a004d9820603 (diff) |
perf script: Fix documentation of '-f' when it should be '-F'
The documentation for perf script mixes up '-f' and '-F'. Fix it.
Signed-off-by: Adrian Hunter <adrian.hunter@intel.com>
Cc: Andi Kleen <ak@linux.intel.com>
Cc: Jiri Olsa <jolsa@redhat.com>
Link: http://lkml.kernel.org/r/None
Signed-off-by: Arnaldo Carvalho de Melo <acme@redhat.com>
Diffstat (limited to 'tools')
-rw-r--r-- | tools/perf/Documentation/perf-script.txt | 20 |
1 files changed, 10 insertions, 10 deletions
diff --git a/tools/perf/Documentation/perf-script.txt b/tools/perf/Documentation/perf-script.txt index 4fc44c75263f..4f34379ebd77 100644 --- a/tools/perf/Documentation/perf-script.txt +++ b/tools/perf/Documentation/perf-script.txt | |||
@@ -119,13 +119,13 @@ OPTIONS | |||
119 | srcline, period, iregs, brstack, brstacksym, flags. | 119 | srcline, period, iregs, brstack, brstacksym, flags. |
120 | Field list can be prepended with the type, trace, sw or hw, | 120 | Field list can be prepended with the type, trace, sw or hw, |
121 | to indicate to which event type the field list applies. | 121 | to indicate to which event type the field list applies. |
122 | e.g., -f sw:comm,tid,time,ip,sym and -f trace:time,cpu,trace | 122 | e.g., -F sw:comm,tid,time,ip,sym and -F trace:time,cpu,trace |
123 | 123 | ||
124 | perf script -f <fields> | 124 | perf script -F <fields> |
125 | 125 | ||
126 | is equivalent to: | 126 | is equivalent to: |
127 | 127 | ||
128 | perf script -f trace:<fields> -f sw:<fields> -f hw:<fields> | 128 | perf script -F trace:<fields> -F sw:<fields> -F hw:<fields> |
129 | 129 | ||
130 | i.e., the specified fields apply to all event types if the type string | 130 | i.e., the specified fields apply to all event types if the type string |
131 | is not given. | 131 | is not given. |
@@ -133,9 +133,9 @@ OPTIONS | |||
133 | The arguments are processed in the order received. A later usage can | 133 | The arguments are processed in the order received. A later usage can |
134 | reset a prior request. e.g.: | 134 | reset a prior request. e.g.: |
135 | 135 | ||
136 | -f trace: -f comm,tid,time,ip,sym | 136 | -F trace: -F comm,tid,time,ip,sym |
137 | 137 | ||
138 | The first -f suppresses trace events (field list is ""), but then the | 138 | The first -F suppresses trace events (field list is ""), but then the |
139 | second invocation sets the fields to comm,tid,time,ip,sym. In this case a | 139 | second invocation sets the fields to comm,tid,time,ip,sym. In this case a |
140 | warning is given to the user: | 140 | warning is given to the user: |
141 | 141 | ||
@@ -143,9 +143,9 @@ OPTIONS | |||
143 | 143 | ||
144 | Alternatively, consider the order: | 144 | Alternatively, consider the order: |
145 | 145 | ||
146 | -f comm,tid,time,ip,sym -f trace: | 146 | -F comm,tid,time,ip,sym -F trace: |
147 | 147 | ||
148 | The first -f sets the fields for all events and the second -f | 148 | The first -F sets the fields for all events and the second -F |
149 | suppresses trace events. The user is given a warning message about | 149 | suppresses trace events. The user is given a warning message about |
150 | the override, and the result of the above is that only S/W and H/W | 150 | the override, and the result of the above is that only S/W and H/W |
151 | events are displayed with the given fields. | 151 | events are displayed with the given fields. |
@@ -154,14 +154,14 @@ OPTIONS | |||
154 | event type, a message is displayed to the user that the option is | 154 | event type, a message is displayed to the user that the option is |
155 | ignored for that type. For example: | 155 | ignored for that type. For example: |
156 | 156 | ||
157 | $ perf script -f comm,tid,trace | 157 | $ perf script -F comm,tid,trace |
158 | 'trace' not valid for hardware events. Ignoring. | 158 | 'trace' not valid for hardware events. Ignoring. |
159 | 'trace' not valid for software events. Ignoring. | 159 | 'trace' not valid for software events. Ignoring. |
160 | 160 | ||
161 | Alternatively, if the type is given an invalid field is specified it | 161 | Alternatively, if the type is given an invalid field is specified it |
162 | is an error. For example: | 162 | is an error. For example: |
163 | 163 | ||
164 | perf script -v -f sw:comm,tid,trace | 164 | perf script -v -F sw:comm,tid,trace |
165 | 'trace' not valid for software events. | 165 | 'trace' not valid for software events. |
166 | 166 | ||
167 | At this point usage is displayed, and perf-script exits. | 167 | At this point usage is displayed, and perf-script exits. |
@@ -173,7 +173,7 @@ OPTIONS | |||
173 | respectively. | 173 | respectively. |
174 | 174 | ||
175 | Finally, a user may not set fields to none for all event types. | 175 | Finally, a user may not set fields to none for all event types. |
176 | i.e., -f "" is not allowed. | 176 | i.e., -F "" is not allowed. |
177 | 177 | ||
178 | The brstack output includes branch related information with raw addresses using the | 178 | The brstack output includes branch related information with raw addresses using the |
179 | /v/v/v/v/ syntax in the following order: | 179 | /v/v/v/v/ syntax in the following order: |