[PATCH v4 2/2] perf record: Update docs regarding the maximum limitation of AUX area

From: Shuai Xue
Date: Fri Aug 04 2023 - 03:32:31 EST


The maximum AUX area is limited by the page size of the system. Update
the documentation to reflect this.

Signed-off-by: Shuai Xue <xueshuai@xxxxxxxxxxxxxxxxx>
---
tools/perf/Documentation/perf-record.txt | 3 +++
1 file changed, 3 insertions(+)

diff --git a/tools/perf/Documentation/perf-record.txt b/tools/perf/Documentation/perf-record.txt
index 680396c56bd1..b0ee7b63da0e 100644
--- a/tools/perf/Documentation/perf-record.txt
+++ b/tools/perf/Documentation/perf-record.txt
@@ -292,6 +292,9 @@ OPTIONS
Also, by adding a comma, the number of mmap pages for AUX
area tracing can be specified.

+ The maximum AUX area is limited by the page size of the system. For
+ example with 4K pages configured, the maximum is 2GiB.
+
-g::
Enables call-graph (stack chain/backtrace) recording for both
kernel space and user space.
--
2.39.3