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

perf docs: Refine the description for the buffer size

Current description for the AUX trace buffer size is misleading. When a
user specifies the option '-m,512M', it represents a size value in bytes
(512MiB) but not 512M pages (512M x 4KiB regard to a page of 4KiB).

Make the document clear that the normal buffer and the AUX tracing
buffer share the same semantics. Syncs the documents for consistent
text.

Reviewed-by: James Clark <james.clark@linaro.org>
Signed-off-by: Leo Yan <leo.yan@arm.com>
Cc: Adrian Hunter <adrian.hunter@intel.com>
Cc: Ingo Molnar <mingo@redhat.com>
Cc: Jiri Olsa <jolsa@kernel.org>
Cc: Kan Liang <kan.liang@linux.intel.com>
Cc: Namhyung Kim <namhyung@kernel.org>
Cc: Peter Zijlstra <peterz@infradead.org>
Link: https://lore.kernel.org/r/20240812093459.2575278-1-leo.yan@arm.com
Signed-off-by: Arnaldo Carvalho de Melo <acme@redhat.com>

authored by

Leo Yan and committed by
Arnaldo Carvalho de Melo
043da846 e6b56ae7

+12 -11
+3 -3
tools/perf/Documentation/perf-kvm.txt
··· 115 115 116 116 -m:: 117 117 --mmap-pages=:: 118 - Number of mmap data pages (must be a power of two) or size 119 - specification with appended unit character - B/K/M/G. The 120 - size is rounded up to have nearest pages power of two value. 118 + Number of mmap data pages (must be a power of two) or size 119 + specification in bytes with appended unit character - B/K/M/G. 120 + The size is rounded up to the nearest power-of-two page value. 121 121 122 122 -a:: 123 123 --all-cpus::
+5 -4
tools/perf/Documentation/perf-record.txt
··· 273 273 -m:: 274 274 --mmap-pages=:: 275 275 Number of mmap data pages (must be a power of two) or size 276 - specification with appended unit character - B/K/M/G. The 277 - size is rounded up to have nearest pages power of two value. 278 - Also, by adding a comma, the number of mmap pages for AUX 279 - area tracing can be specified. 276 + specification in bytes with appended unit character - B/K/M/G. 277 + The size is rounded up to the nearest power-of-two page value. 278 + By adding a comma, an additional parameter with the same 279 + semantics used for the normal mmap areas can be specified for 280 + AUX tracing area. 280 281 281 282 -g:: 282 283 Enables call-graph (stack chain/backtrace) recording for both
+2 -2
tools/perf/Documentation/perf-top.txt
··· 83 83 -m <pages>:: 84 84 --mmap-pages=<pages>:: 85 85 Number of mmap data pages (must be a power of two) or size 86 - specification with appended unit character - B/K/M/G. The 87 - size is rounded up to have nearest pages power of two value. 86 + specification in bytes with appended unit character - B/K/M/G. 87 + The size is rounded up to the nearest power-of-two page value. 88 88 89 89 -p <pid>:: 90 90 --pid=<pid>::
+2 -2
tools/perf/Documentation/perf-trace.txt
··· 106 106 -m:: 107 107 --mmap-pages=:: 108 108 Number of mmap data pages (must be a power of two) or size 109 - specification with appended unit character - B/K/M/G. The 110 - size is rounded up to have nearest pages power of two value. 109 + specification in bytes with appended unit character - B/K/M/G. 110 + The size is rounded up to the nearest power-of-two page value. 111 111 112 112 -C:: 113 113 --cpu::