perf list: Document missing options
PATCH 1/1 perf list: Document missing options
Add the missing options --desc and --debug on the man page.
--- tools/perf/Documentation/perf-list.txt | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-)
tools/perf/Documentation/perf-list.txt +7 -1
@@ -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 ---------------
Signature · 1 line
2.17.1
Arnaldo Carvalho de Melo
maintainerEm Tue, Jul 17, 2018 at 08:07:38PM +0900, Sangwon Hong escreveu:
Quoted 1 line
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
Quoted 40 lines
Cc Jiri Olsa <[email protected]>Cc Namhyung Kim <[email protected]>Cc Andi Kleen <[email protected]>Signed-off-by Sangwon Hong <[email protected]>--- tools/perf/Documentation/perf-list.txt | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-)tools/perf/Documentation/perf-list.txt +7
-1@@ -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 ---------------Signature · 1 line
2.17.1
Arnaldo Carvalho de Melo
maintainerEm Tue, Jul 17, 2018 at 03:28:52PM -0300, Arnaldo Carvalho de Melo escreveu:
Quoted 5 lines
Em Tue, Jul 17, 2018 at 08:07:38PM +0900, Sangwon Hong escreveu:
Quoted 1 line
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
tip-bot for Sangwon Hong
merge bot[tip:perf/core] perf list: Add missing documentation for --desc and --debug options
In reply to Sangwon Hongperf list: Add missing documentation for --desc and --debug options
Commit-ID: 6feb3fec519ed112f7a77af4e51e51a35148d01c Gitweb: https://git.kernel.org/tip/6feb3fec519ed112f7a77af4e51e51a35148d01c Author: Sangwon Hong <[email protected]> AuthorDate: Tue, 17 Jul 2018 20:07:38 +0900 Committer: Arnaldo Carvalho de Melo <[email protected]> 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.
--- tools/perf/Documentation/perf-list.txt | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-)
tools/perf/Documentation/perf-list.txt +7 -1
@@ -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 ---------------