[PATCH v1 2/2] perf docs: Add documentation for --force-btf option

Howard Chu posted 2 patches 1 year, 2 months ago
There is a newer version of this series
[PATCH v1 2/2] perf docs: Add documentation for --force-btf option
Posted by Howard Chu 1 year, 2 months ago
The --force-btf option is intended for debugging purposes and is
currently undocumented. Add documentation for it.

Signed-off-by: Howard Chu <howardchu95@gmail.com>
---
 tools/perf/Documentation/perf-trace.txt | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/tools/perf/Documentation/perf-trace.txt b/tools/perf/Documentation/perf-trace.txt
index 6e0cc50bbc13..529081599cc7 100644
--- a/tools/perf/Documentation/perf-trace.txt
+++ b/tools/perf/Documentation/perf-trace.txt
@@ -241,6 +241,9 @@ the thread executes on the designated CPUs. Default is to monitor all CPUs.
 	printing using the existing 'perf trace' syscall arg beautifiers to map integer
 	arguments to strings (pid to comm, syscall id to syscall name, etc).
 
+--force-btf::
+	Use btf_dump to pretty print syscall argument data, instead of using hand-crafted pretty printers.
+
 
 PAGEFAULTS
 ----------
-- 
2.43.0
Re: [PATCH v1 2/2] perf docs: Add documentation for --force-btf option
Posted by Arnaldo Carvalho de Melo 1 year, 2 months ago
On Fri, Nov 22, 2024 at 04:55:11PM -0800, Howard Chu wrote:
> The --force-btf option is intended for debugging purposes and is
> currently undocumented. Add documentation for it.
> 
> Signed-off-by: Howard Chu <howardchu95@gmail.com>
> ---
>  tools/perf/Documentation/perf-trace.txt | 3 +++
>  1 file changed, 3 insertions(+)
> 
> diff --git a/tools/perf/Documentation/perf-trace.txt b/tools/perf/Documentation/perf-trace.txt
> index 6e0cc50bbc13..529081599cc7 100644
> --- a/tools/perf/Documentation/perf-trace.txt
> +++ b/tools/perf/Documentation/perf-trace.txt
> @@ -241,6 +241,9 @@ the thread executes on the designated CPUs. Default is to monitor all CPUs.
>  	printing using the existing 'perf trace' syscall arg beautifiers to map integer
>  	arguments to strings (pid to comm, syscall id to syscall name, etc).
>  
> +--force-btf::
> +	Use btf_dump to pretty print syscall argument data, instead of using hand-crafted pretty printers.
> +

I think here we could expand a bit and explain that we want this for
testing the BTF code, and also mention that the hand-crafted pretty
printers know about integers -> strings, how to pretty print flags, etc
that BTF doesn't.

- Arnaldo

>  
>  PAGEFAULTS
>  ----------
> -- 
> 2.43.0