[PATCH] perf tools: Fix documentation of verbose options

[PATCH] perf tools: Fix documentation of verbose options

[Ian Rogers]

Option doesn't take a value, make sure the man pages agree. For example:

$ perf evlist --verbose=1
 Error: option `verbose' takes no value

Signed-off-by: Ian Rogers <irogers@google.com>
---
 tools/perf/Documentation/perf-evlist.txt   | 2 +-
 tools/perf/Documentation/perf-ftrace.txt   | 4 ++--
 tools/perf/Documentation/perf-kallsyms.txt | 2 +-
 tools/perf/Documentation/perf-trace.txt    | 4 ++--
 4 files changed, 6 insertions(+), 6 deletions(-)

diff --git a/tools/perf/Documentation/perf-evlist.txt b/tools/perf/Documentation/perf-evlist.txt
index c0a66400a960..9af8b8dfb7b6 100644
--- a/tools/perf/Documentation/perf-evlist.txt
+++ b/tools/perf/Documentation/perf-evlist.txt
@@ -29,7 +29,7 @@ OPTIONS
 	Show just the sample frequency used for each event.
 
 -v::
---verbose=::
+--verbose::
 	Show all fields.
 
 -g::
diff --git a/tools/perf/Documentation/perf-ftrace.txt b/tools/perf/Documentation/perf-ftrace.txt
index 1e91121bac0f..6e82b7cc0bf0 100644
--- a/tools/perf/Documentation/perf-ftrace.txt
+++ b/tools/perf/Documentation/perf-ftrace.txt
@@ -28,8 +28,8 @@ OPTIONS
 	specified: function_graph or function.
 
 -v::
---verbose=::
-        Verbosity level.
+--verbose::
+        Increase the verbosity level.
 
 -F::
 --funcs::
diff --git a/tools/perf/Documentation/perf-kallsyms.txt b/tools/perf/Documentation/perf-kallsyms.txt
index f3c620951f6e..c97527df8ecd 100644
--- a/tools/perf/Documentation/perf-kallsyms.txt
+++ b/tools/perf/Documentation/perf-kallsyms.txt
@@ -20,5 +20,5 @@ modules).
 OPTIONS
 -------
 -v::
---verbose=::
+--verbose::
 	Increase verbosity level, showing details about symbol table loading, etc.
diff --git a/tools/perf/Documentation/perf-trace.txt b/tools/perf/Documentation/perf-trace.txt
index abc9b5d83312..f0da8cf63e9a 100644
--- a/tools/perf/Documentation/perf-trace.txt
+++ b/tools/perf/Documentation/perf-trace.txt
@@ -97,8 +97,8 @@ filter out the startup phase of the program, which is often very different.
 	Filter out events for these pids and for 'trace' itself (comma separated list).
 
 -v::
---verbose=::
-        Verbosity level.
+--verbose::
+        Increase the verbosity level.
 
 --no-inherit::
 	Child tasks do not inherit counters.
-- 
2.30.1.766.gb4fecdf3b7-goog

Re: [PATCH] perf tools: Fix documentation of verbose options

[Arnaldo Carvalho de Melo]

Em Fri, Feb 26, 2021 at 10:31:44AM -0800, Ian Rogers escreveu:
> Option doesn't take a value, make sure the man pages agree. For example:
> 
> $ perf evlist --verbose=1
>  Error: option `verbose' takes no value

Thanks, applied.

- Arnaldo

 
> Signed-off-by: Ian Rogers <irogers@google.com>
> ---
>  tools/perf/Documentation/perf-evlist.txt   | 2 +-
>  tools/perf/Documentation/perf-ftrace.txt   | 4 ++--
>  tools/perf/Documentation/perf-kallsyms.txt | 2 +-
>  tools/perf/Documentation/perf-trace.txt    | 4 ++--
>  4 files changed, 6 insertions(+), 6 deletions(-)
> 
> diff --git a/tools/perf/Documentation/perf-evlist.txt b/tools/perf/Documentation/perf-evlist.txt
> index c0a66400a960..9af8b8dfb7b6 100644
> --- a/tools/perf/Documentation/perf-evlist.txt
> +++ b/tools/perf/Documentation/perf-evlist.txt
> @@ -29,7 +29,7 @@ OPTIONS
>  	Show just the sample frequency used for each event.
>  
>  -v::
> ---verbose=::
> +--verbose::
>  	Show all fields.
>  
>  -g::
> diff --git a/tools/perf/Documentation/perf-ftrace.txt b/tools/perf/Documentation/perf-ftrace.txt
> index 1e91121bac0f..6e82b7cc0bf0 100644
> --- a/tools/perf/Documentation/perf-ftrace.txt
> +++ b/tools/perf/Documentation/perf-ftrace.txt
> @@ -28,8 +28,8 @@ OPTIONS
>  	specified: function_graph or function.
>  
>  -v::
> ---verbose=::
> -        Verbosity level.
> +--verbose::
> +        Increase the verbosity level.
>  
>  -F::
>  --funcs::
> diff --git a/tools/perf/Documentation/perf-kallsyms.txt b/tools/perf/Documentation/perf-kallsyms.txt
> index f3c620951f6e..c97527df8ecd 100644
> --- a/tools/perf/Documentation/perf-kallsyms.txt
> +++ b/tools/perf/Documentation/perf-kallsyms.txt
> @@ -20,5 +20,5 @@ modules).
>  OPTIONS
>  -------
>  -v::
> ---verbose=::
> +--verbose::
>  	Increase verbosity level, showing details about symbol table loading, etc.
> diff --git a/tools/perf/Documentation/perf-trace.txt b/tools/perf/Documentation/perf-trace.txt
> index abc9b5d83312..f0da8cf63e9a 100644
> --- a/tools/perf/Documentation/perf-trace.txt
> +++ b/tools/perf/Documentation/perf-trace.txt
> @@ -97,8 +97,8 @@ filter out the startup phase of the program, which is often very different.
>  	Filter out events for these pids and for 'trace' itself (comma separated list).
>  
>  -v::
> ---verbose=::
> -        Verbosity level.
> +--verbose::
> +        Increase the verbosity level.
>  
>  --no-inherit::
>  	Child tasks do not inherit counters.
> -- 
> 2.30.1.766.gb4fecdf3b7-goog
> 

-- 

- Arnaldo