* [PATCH] perf list: Document missing options
@ 2018-07-17 11:07 Sangwon Hong
2018-07-17 18:28 ` 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
0 siblings, 2 replies; 4+ messages in thread
From: Sangwon Hong @ 2018-07-17 11:07 UTC (permalink / raw)
To: Arnaldo Carvalho de Melo
Cc: linux-kernel, Jiri Olsa, Namhyung Kim, Andi Kleen, Sangwon Hong
Add the missing options --desc and --debug on the man page.
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
^ permalink raw reply related [flat|nested] 4+ messages in thread
* Re: [PATCH] perf list: Document missing options
2018-07-17 11:07 [PATCH] perf list: Document missing options Sangwon Hong
@ 2018-07-17 18:28 ` Arnaldo Carvalho de Melo
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
1 sibling, 1 reply; 4+ messages in thread
From: Arnaldo Carvalho de Melo @ 2018-07-17 18:28 UTC (permalink / raw)
To: Sangwon Hong; +Cc: linux-kernel, Jiri Olsa, Namhyung Kim, Andi Kleen
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
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [PATCH] perf list: Document missing options
2018-07-17 18:28 ` Arnaldo Carvalho de Melo
@ 2018-07-17 18:33 ` Arnaldo Carvalho de Melo
0 siblings, 0 replies; 4+ messages in thread
From: Arnaldo Carvalho de Melo @ 2018-07-17 18:33 UTC (permalink / raw)
To: Sangwon Hong; +Cc: linux-kernel, Jiri Olsa, Namhyung Kim, Andi Kleen
Em Tue, Jul 17, 2018 at 03:28:52PM -0300, Arnaldo Carvalho de Melo escreveu:
> 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?
Also please make the summary line more descriptive, I've changed it from:
perf list: Document missing options
To:
perf list: Add missing documentation for --desc and --debug options
So that when one uses:
git log --oneline
we get this extra bit of info. Also what is missing is the documentation
for the options, not the options :-)
- Arnaldo
^ permalink raw reply [flat|nested] 4+ messages in thread
* [tip:perf/core] perf list: Add missing documentation for --desc and --debug options
2018-07-17 11:07 [PATCH] perf list: Document missing options Sangwon Hong
2018-07-17 18:28 ` Arnaldo Carvalho de Melo
@ 2018-07-25 20:44 ` tip-bot for Sangwon Hong
1 sibling, 0 replies; 4+ messages in thread
From: tip-bot for Sangwon Hong @ 2018-07-25 20:44 UTC (permalink / raw)
To: linux-tip-commits
Cc: namhyung, acme, linux-kernel, ak, tglx, mingo, qpakzk, hpa, jolsa
Commit-ID: 6feb3fec519ed112f7a77af4e51e51a35148d01c
Gitweb: https://git.kernel.org/tip/6feb3fec519ed112f7a77af4e51e51a35148d01c
Author: Sangwon Hong <qpakzk@gmail.com>
AuthorDate: Tue, 17 Jul 2018 20:07:38 +0900
Committer: Arnaldo Carvalho de Melo <acme@redhat.com>
CommitDate: Tue, 24 Jul 2018 14:49:57 -0300
perf list: Add missing documentation for --desc and --debug options
Add missing documentation for --desc and --debug options to the 'perf
list' man page.
Signed-off-by: Sangwon Hong <qpakzk@gmail.com>
Cc: Andi Kleen <ak@linux.intel.com>
Cc: Jiri Olsa <jolsa@kernel.org>
Cc: Namhyung Kim <namhyung@kernel.org>
Link: http://lkml.kernel.org/r/20180717110738.10779-1-qpakzk@gmail.com
[ Clarify that --desc is by default active ]
Signed-off-by: Arnaldo Carvalho de Melo <acme@redhat.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..236b9b97dfdb 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. (default)
+
--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
---------------
^ permalink raw reply related [flat|nested] 4+ messages in thread
end of thread, other threads:[~2018-07-25 20:44 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2018-07-17 11:07 [PATCH] perf list: Document missing options Sangwon Hong
2018-07-17 18:28 ` Arnaldo Carvalho de Melo
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
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).