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>

diff --git a/tools/perf/Documentation/perf-kvm.txt b/tools/perf/Documentation/perf-kvm.txt
index b66be66fe836ad965adc38fdc8a6f9df98233797..c26524d38f476dfeacee858dafe76a8cf706fa04 100644 (file)
--- a/tools/perf/Documentation/perf-kvm.txt
+++ b/tools/perf/Documentation/perf-kvm.txt
@@ -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::

diff --git a/tools/perf/Documentation/perf-record.txt b/tools/perf/Documentation/perf-record.txt
index 41e36b4dc765f671b0623357bc5b21505033e8ff..242223240a08045e0e6e5c946737cdb8896f8294 100644 (file)
--- a/tools/perf/Documentation/perf-record.txt
+++ b/tools/perf/Documentation/perf-record.txt
@@ -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

diff --git a/tools/perf/Documentation/perf-top.txt b/tools/perf/Documentation/perf-top.txt
index 667e5102075e28daeca7da4e0d982afc2cb03ffa..af3e4230c72f41b85d3cb359c1101470a7d3a202 100644 (file)
--- a/tools/perf/Documentation/perf-top.txt
+++ b/tools/perf/Documentation/perf-top.txt
@@ -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>::

diff --git a/tools/perf/Documentation/perf-trace.txt b/tools/perf/Documentation/perf-trace.txt
index f0da8cf63e9a965a1ee162dc39559f8f172680e2..6e0cc50bbc13fc7f620ffe2170890162afbd399c 100644 (file)
--- a/tools/perf/Documentation/perf-trace.txt
+++ b/tools/perf/Documentation/perf-trace.txt
@@ -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::