Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

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>

authored by

Andi Kleen and committed by
Arnaldo Carvalho de Melo
e89eaa61 0c361c6e

+2 -12
-10
tools/perf/Documentation/intel-hybrid.txt
··· 21 21 22 22 It indicates cpu0-cpu15 are core cpus and cpu16-cpu23 are atom cpus. 23 23 24 - Quickstart 25 - 26 - List hybrid event 27 - ----------------- 28 - 29 24 As before, use perf-list to list the symbolic event. 30 25 31 26 perf list ··· 35 40 be supported. 36 41 37 42 Enable hybrid event with a specific pmu 38 - --------------------------------------- 39 43 40 44 To enable a core only event or atom only event, following syntax is supported: 41 45 ··· 47 53 perf stat -e cpu_core/cycles/ 48 54 49 55 Create two events for one hardware event automatically 50 - ------------------------------------------------------ 51 56 52 57 When creating one event and the event is available on both atom and core, 53 58 two events are created automatically. One is for atom, the other is for ··· 125 132 The first 'cycles' is core event, the second 'cycles' is atom event. 126 133 127 134 Thread mode example: 128 - -------------------- 129 135 130 136 perf-stat reports the scaled counts for hybrid event and with a percentage 131 137 displayed. The percentage is the event's running time/enabling time. ··· 168 176 604,097,080 cpu_atom/cycles/ (99.57%) 169 177 170 178 perf-record: 171 - ------------ 172 179 173 180 If there is no '-e' specified in perf record, on hybrid platform, 174 181 it creates two default 'cycles' and adds them to event list. One 175 182 is for core, the other is for atom. 176 183 177 184 perf-stat: 178 - ---------- 179 185 180 186 If there is no '-e' specified in perf stat, on hybrid platform, 181 187 besides of software events, following events are created and
+2 -2
tools/perf/Documentation/perf-record.txt
··· 757 757 defaults to CPU layout. Masks defined or provided by the option value are 758 758 filtered through the mask provided by -C option. 759 759 760 - include::intel-hybrid.txt[] 761 - 762 760 --debuginfod[=URLs]:: 763 761 Specify debuginfod URL to be used when cacheing perf.data binaries, 764 762 it follows the same syntax as the DEBUGINFOD_URLS variable, like: ··· 775 777 Note that BPF can collect stack traces using frame pointer ("fp") 776 778 only, as of now. So the applications built without the frame 777 779 pointer might see bogus addresses. 780 + 781 + include::intel-hybrid.txt[] 778 782 779 783 SEE ALSO 780 784 --------