Re: [PATCH] perf list: Document missing options

[Arnaldo Carvalho de Melo]

Em Tue, Jul 17, 2018 at 08:07:38PM +0900, Sangwon Hong escreveu:
> Add the missing options --desc and --debug on the man page.

Please describe how you tested this, i.e. what difference makes using
this option you are describing?

I figured it doesn't change anything, since it is the default, so to
test if this makes any change one needs to compare the output of:

   perf list --no-desc

with the output of what you just documented, i.e.:

   perf list --desc

comparing what you added with not using any option shows no difference.

Thus we need to add this "(default)" to your patch, to avoid confusion:

+-d::
+--desc::
+Print extra event descriptions. (default)

I'm doing this, please consider adding this to any further work in this
area.
 
- Arnaldo

> Cc: Jiri Olsa <jolsa@xxxxxxxxxx>
> Cc: Namhyung Kim <namhyung@xxxxxxxxxx>
> Cc: Andi Kleen <ak@xxxxxxxxxxxxxxx>
> Signed-off-by: Sangwon Hong <qpakzk@xxxxxxxxx>
> ---
>  tools/perf/Documentation/perf-list.txt | 8 +++++++-
>  1 file changed, 7 insertions(+), 1 deletion(-)
> 
> diff --git a/tools/perf/Documentation/perf-list.txt b/tools/perf/Documentation/perf-list.txt
> index 14e13512c05f..1d3fb2846d2d 100644
> --- a/tools/perf/Documentation/perf-list.txt
> +++ b/tools/perf/Documentation/perf-list.txt
> @@ -18,6 +18,10 @@ various perf commands with the -e option.
>  
>  OPTIONS
>  -------
> +-d::
> +--desc::
> +Print extra event descriptions.
> +
>  --no-desc::
>  Don't print descriptions.
>  
> @@ -25,11 +29,13 @@ Don't print descriptions.
>  --long-desc::
>  Print longer event descriptions.
>  
> +--debug::
> +Enable debugging output.
> +
>  --details::
>  Print how named events are resolved internally into perf events, and also
>  any extra expressions computed by perf stat.
>  
> -
>  [[EVENT_MODIFIERS]]
>  EVENT MODIFIERS
>  ---------------
> -- 
> 2.17.1