perf list: update option desc in man page

[PATCH] perf list: update option desc in man page

Posted by Yoshihiro Furudera 1 month, 3 weeks ago

There is a difference between the SYNOPSIS section of the help message
and the man page (tools/perf/Documentation/perf-list.txt) for the perf
list command. After checking, we found that the help message reflected
the latest specifications. Therefore, revised the SYNOPSIS section of
the man page to match the help message.

Signed-off-by: Yoshihiro Furudera <fj5100bi@fujitsu.com>
---
 tools/perf/Documentation/perf-list.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/tools/perf/Documentation/perf-list.txt b/tools/perf/Documentation/perf-list.txt
index dea005410ec0..14621f39b375 100644
--- a/tools/perf/Documentation/perf-list.txt
+++ b/tools/perf/Documentation/perf-list.txt
@@ -8,7 +8,7 @@ perf-list - List all symbolic event types
 SYNOPSIS
 --------
 [verse]
-'perf list' [--no-desc] [--long-desc]
+'perf list' [<options>]
             [hw|sw|cache|tracepoint|pmu|sdt|metric|metricgroup|event_glob]
 
 DESCRIPTION
-- 
2.34.1

Re: [PATCH] perf list: update option desc in man page

Posted by Namhyung Kim 1 month, 3 weeks ago

On Thu, 03 Oct 2024 00:24:04 +0000, Yoshihiro Furudera wrote:

> There is a difference between the SYNOPSIS section of the help message
> and the man page (tools/perf/Documentation/perf-list.txt) for the perf
> list command. After checking, we found that the help message reflected
> the latest specifications. Therefore, revised the SYNOPSIS section of
> the man page to match the help message.
> 
> 
> [...]

Applied to perf-tools-next, thanks!

Best regards,
Namhyung