From: Arnaldo Carvalho de Melo <acme@kernel.org>
To: Sangwon Hong <qpakzk@gmail.com>
Cc: linux-kernel@vger.kernel.org, Jiri Olsa <jolsa@kernel.org>,
Namhyung Kim <namhyung@kernel.org>,
Andi Kleen <ak@linux.intel.com>
Subject: Re: [PATCH] perf list: Document missing options
Date: Tue, 17 Jul 2018 15:28:52 -0300 [thread overview]
Message-ID: <20180717182852.GB3614@kernel.org> (raw)
In-Reply-To: <20180717110738.10779-1-qpakzk@gmail.com>
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@kernel.org>
> Cc: Namhyung Kim <namhyung@kernel.org>
> Cc: Andi Kleen <ak@linux.intel.com>
> Signed-off-by: Sangwon Hong <qpakzk@gmail.com>
> ---
> 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
next prev parent reply other threads:[~2018-07-17 18:28 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-07-17 11:07 [PATCH] perf list: Document missing options Sangwon Hong
2018-07-17 18:28 ` Arnaldo Carvalho de Melo [this message]
2018-07-17 18:33 ` Arnaldo Carvalho de Melo
2018-07-25 20:44 ` [tip:perf/core] perf list: Add missing documentation for --desc and --debug options tip-bot for Sangwon Hong
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20180717182852.GB3614@kernel.org \
--to=acme@kernel.org \
--cc=ak@linux.intel.com \
--cc=jolsa@kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=namhyung@kernel.org \
--cc=qpakzk@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).