Skip to content

Commit e89eaa6

Browse files
Andi Kleenacmel
authored andcommitted
perf record: Fix manpage formatting of description of support to hybrid systems
The Intel hybrid description is written in a different style than the rest of the perf record man page. There were some new command line options added after it which resulted in very strange section ordering. Move the hybrid include last. Also the sub sections in the hybrid document don't fit the record manpage well (especially since it talks about all kinds of unrelated commands). I left this for now, but would be better to separate this properly in the different man pages. It would be better to use sub sections for the other sections, but these don't seem to be supported in AsciiDoc? Some of the examples are still misrendered in the manpage with an indented troff command, but I don't know how to fix that. In any case it's now better than before. Signed-off-by: Andi Kleen <ak@linux.intel.com> Cc: zhengjun.xing@intel.com Link: https://lore.kernel.org/r/20220818100127.249401-1-ak@linux.intel.com Signed-off-by: Arnaldo Carvalho de Melo <acme@redhat.com>
1 parent 0c361c6 commit e89eaa6

File tree

2 files changed

+2
-12
lines changed

2 files changed

+2
-12
lines changed

tools/perf/Documentation/intel-hybrid.txt

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,6 @@ cat /sys/devices/cpu_atom/cpus
2121

2222
It indicates cpu0-cpu15 are core cpus and cpu16-cpu23 are atom cpus.
2323

24-
Quickstart
25-
26-
List hybrid event
27-
-----------------
28-
2924
As before, use perf-list to list the symbolic event.
3025

3126
perf list
@@ -40,7 +35,6 @@ the event is belong to. Same event name but with different pmu can
4035
be supported.
4136

4237
Enable hybrid event with a specific pmu
43-
---------------------------------------
4438

4539
To enable a core only event or atom only event, following syntax is supported:
4640

@@ -53,7 +47,6 @@ For example, count the 'cycles' event on core cpus.
5347
perf stat -e cpu_core/cycles/
5448

5549
Create two events for one hardware event automatically
56-
------------------------------------------------------
5750

5851
When creating one event and the event is available on both atom and core,
5952
two events are created automatically. One is for atom, the other is for
@@ -132,7 +125,6 @@ For perf-stat result, it displays two events:
132125
The first 'cycles' is core event, the second 'cycles' is atom event.
133126

134127
Thread mode example:
135-
--------------------
136128

137129
perf-stat reports the scaled counts for hybrid event and with a percentage
138130
displayed. The percentage is the event's running time/enabling time.
@@ -176,14 +168,12 @@ perf_event_attr:
176168
604,097,080 cpu_atom/cycles/ (99.57%)
177169

178170
perf-record:
179-
------------
180171

181172
If there is no '-e' specified in perf record, on hybrid platform,
182173
it creates two default 'cycles' and adds them to event list. One
183174
is for core, the other is for atom.
184175

185176
perf-stat:
186-
----------
187177

188178
If there is no '-e' specified in perf stat, on hybrid platform,
189179
besides of software events, following events are created and

tools/perf/Documentation/perf-record.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -757,8 +757,6 @@ events in data directory files. Option specified with no or empty value
757757
defaults to CPU layout. Masks defined or provided by the option value are
758758
filtered through the mask provided by -C option.
759759

760-
include::intel-hybrid.txt[]
761-
762760
--debuginfod[=URLs]::
763761
Specify debuginfod URL to be used when cacheing perf.data binaries,
764762
it follows the same syntax as the DEBUGINFOD_URLS variable, like:
@@ -778,6 +776,8 @@ include::intel-hybrid.txt[]
778776
only, as of now. So the applications built without the frame
779777
pointer might see bogus addresses.
780778

779+
include::intel-hybrid.txt[]
780+
781781
SEE ALSO
782782
--------
783783
linkperf:perf-stat[1], linkperf:perf-list[1], linkperf:perf-intel-pt[1]

0 commit comments

Comments
 (0)