perf docs: Refine the description for the buffer size
PATCH v2 1/1 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.
---
Changes from v1:
Synced for all documents for consistent description (James)
tools/perf/Documentation/perf-kvm.txt | 6 +++--- tools/perf/Documentation/perf-record.txt | 9 +++++---- tools/perf/Documentation/perf-top.txt | 4 ++-- tools/perf/Documentation/perf-trace.txt | 4 ++-- 4 files changed, 12 insertions(+), 11 deletions(-)
tools/perf/Documentation/perf-kvm.txt +3 -3
@@ -115,9 +115,9 @@ STAT LIVE OPTIONS -m:: --mmap-pages=:: - Number of mmap data pages (must be a power of two) or size - specification with appended unit character - B/K/M/G. The - size is rounded up to have nearest pages power of two value. + Number of mmap data pages (must be a power of two) or size + specification in bytes with appended unit character - B/K/M/G. + The size is rounded up to the nearest power-of-two page value. -a:: --all-cpus::
tools/perf/Documentation/perf-record.txt +5 -4
@@ -273,10 +273,11 @@ OPTIONS -m:: --mmap-pages=:: Number of mmap data pages (must be a power of two) or size - specification with appended unit character - B/K/M/G. The - size is rounded up to have nearest pages power of two value. - Also, by adding a comma, the number of mmap pages for AUX - area tracing can be specified. + specification in bytes with appended unit character - B/K/M/G. + The size is rounded up to the nearest power-of-two page value. + By adding a comma, an additional parameter with the same + semantics used for the normal mmap areas can be specified for + AUX tracing area. -g:: Enables call-graph (stack chain/backtrace) recording for both
tools/perf/Documentation/perf-top.txt +2 -2
@@ -83,8 +83,8 @@ Default is to monitor all CPUS. -m <pages>:: --mmap-pages=<pages>:: Number of mmap data pages (must be a power of two) or size - specification with appended unit character - B/K/M/G. The - size is rounded up to have nearest pages power of two value. + specification in bytes with appended unit character - B/K/M/G. + The size is rounded up to the nearest power-of-two page value. -p <pid>:: --pid=<pid>::
tools/perf/Documentation/perf-trace.txt +2 -2
@@ -106,8 +106,8 @@ filter out the startup phase of the program, which is often very different. -m:: --mmap-pages=:: Number of mmap data pages (must be a power of two) or size - specification with appended unit character - B/K/M/G. The - size is rounded up to have nearest pages power of two value. + specification in bytes with appended unit character - B/K/M/G. + The size is rounded up to the nearest power-of-two page value. -C:: --cpu::
Signature · 1 line
2.34.1
Quoted 8 lines · Leo Yan
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.
Quoted 6 lines
Signed-off-by Leo Yan <[email protected]>Reviewed-by James Clark <[email protected]>---
Changes from v1:
Synced for all documents for consistent description (James)
Thanks, applied to tmp.perf-tools-next,
- Arnaldo
Quoted 75 lines
tools/perf/Documentation/perf-kvm.txt | 6 +++--- tools/perf/Documentation/perf-record.txt | 9 +++++---- tools/perf/Documentation/perf-top.txt | 4 ++-- tools/perf/Documentation/perf-trace.txt | 4 ++-- 4 files changed, 12 insertions(+), 11 deletions(-)tools/perf/Documentation/perf-kvm.txt +3
-3@@ -115,9 +115,9 @@ STAT LIVE OPTIONS -m:: --mmap-pages=:: - Number of mmap data pages (must be a power of two) or size - specification with appended unit character - B/K/M/G. The - size is rounded up to have nearest pages power of two value. + Number of mmap data pages (must be a power of two) or size + specification in bytes with appended unit character - B/K/M/G. + The size is rounded up to the nearest power-of-two page value. -a:: --all-cpus::tools/perf/Documentation/perf-record.txt +5
-4@@ -273,10 +273,11 @@ OPTIONS -m:: --mmap-pages=:: Number of mmap data pages (must be a power of two) or size - specification with appended unit character - B/K/M/G. The - size is rounded up to have nearest pages power of two value. - Also, by adding a comma, the number of mmap pages for AUX - area tracing can be specified. + specification in bytes with appended unit character - B/K/M/G. + The size is rounded up to the nearest power-of-two page value. + By adding a comma, an additional parameter with the same + semantics used for the normal mmap areas can be specified for + AUX tracing area. -g:: Enables call-graph (stack chain/backtrace) recording for bothtools/perf/Documentation/perf-top.txt +2
-2@@ -83,8 +83,8 @@ Default is to monitor all CPUS. -m <pages>:: --mmap-pages=<pages>:: Number of mmap data pages (must be a power of two) or size - specification with appended unit character - B/K/M/G. The - size is rounded up to have nearest pages power of two value. + specification in bytes with appended unit character - B/K/M/G. + The size is rounded up to the nearest power-of-two page value. -p <pid>:: --pid=<pid>::tools/perf/Documentation/perf-trace.txt +2
-2@@ -106,8 +106,8 @@ filter out the startup phase of the program, which is often very different. -m:: --mmap-pages=:: Number of mmap data pages (must be a power of two) or size - specification with appended unit character - B/K/M/G. The - size is rounded up to have nearest pages power of two value. + specification in bytes with appended unit character - B/K/M/G. + The size is rounded up to the nearest power-of-two page value. -C:: --cpu::Signature · 1 line
2.34.1