Skip to contentSkip to conversation

perf kallsyms: Fix the usage on the man page

PATCH Applied Sangwon Hong 4 participants 5 messages Feb 11, 2018 – Mar 7, 2018 perf events

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 perf kallsyms: Fix the usage on the man page

First, all man pages highlight only perf and subcommands except perf kallsyms, which includes the full usage. Fix it for commands to monopolize underlines.

Second, options can skip when executing perf kallsyms, so add square brackets between <option>.

Cc Jiri Olsa <[email protected]>
Cc Namhyung Kim <[email protected]>
Cc Taeung Song <[email protected]>
---
 tools/perf/Documentation/perf-kallsyms.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
tools/perf/Documentation/perf-kallsyms.txt +1 -1
index 954ea9e..cf9f404 100644
@@ -8,7 +8,7 @@ perf-kallsyms - Searches running kernel for symbols
 SYNOPSIS
 --------
 [verse]
-'perf kallsyms <options> symbol_name[,symbol_name...]'
+'perf kallsyms' [<options>] symbol_name[,symbol_name...]
 
 DESCRIPTION
 -----------
Signature · 1 line
2.7.4
maintainer Acked-by on v1 1/1
#1 lore raw
Quoted 11 lines · Sangwon Hong

First, all man pages highlight only perf and subcommands except perf kallsyms, which includes the full usage. Fix it for commands to monopolize underlines.

Second, options can skip when executing perf kallsyms, so add square brackets between <option>.

Cc Jiri Olsa <[email protected]>
Cc Namhyung Kim <[email protected]>
Cc Taeung Song <[email protected]>

Thanks,
Namhyung

Quoted 20 lines
---
 tools/perf/Documentation/perf-kallsyms.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
tools/perf/Documentation/perf-kallsyms.txt +1 -1
index 954ea9e..cf9f404 100644
@@ -8,7 +8,7 @@ perf-kallsyms - Searches running kernel for symbols
 SYNOPSIS
 --------
 [verse]
-'perf kallsyms <options> symbol_name[,symbol_name...]'
+'perf kallsyms' [<options>] symbol_name[,symbol_name...]
 
 DESCRIPTION
 -----------
Signature · 1 line
2.7.4
maintainer Applied
#2 lore raw

Em Mon, Feb 12, 2018 at 10:50:21AM +0900, Namhyung Kim escreveu:

Quoted 8 lines · Sangwon Hong
Quoted 7 lines

First, all man pages highlight only perf and subcommands except perf kallsyms, which includes the full usage. Fix it for commands to monopolize underlines.

Second, options can skip when executing perf kallsyms, so add square brackets between <option>.

Quoted 6 lines
Quoted 4 lines
Cc Jiri Olsa <[email protected]>
Cc Namhyung Kim <[email protected]>
Cc Taeung Song <[email protected]>

Thanks, applied.

- Arnaldo

#3 lore raw
In reply to Sangwon Hong
perf kallsyms: Fix the usage on the man page
Commit-ID:  de7112868829b3286def38297848d5d2592b4a70
Gitweb:     https://git.kernel.org/tip/de7112868829b3286def38297848d5d2592b4a70
Author:     Sangwon Hong <[email protected]>
AuthorDate: Mon, 12 Feb 2018 04:37:44 +0900
Committer:  Arnaldo Carvalho de Melo <[email protected]>
CommitDate: Wed, 21 Feb 2018 09:23:36 -0300

perf kallsyms: Fix the usage on the man page

First, all man pages highlight only perf and subcommands except 'perf kallsyms', which includes the full usage. Fix it for commands to monopolize underlines.

Second, options can be ommited when executing 'perf kallsyms', so add square brackets between <option>.

---
 tools/perf/Documentation/perf-kallsyms.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
tools/perf/Documentation/perf-kallsyms.txt +1 -1
index 954ea9e21236..cf9f4040ea5c 100644
@@ -8,7 +8,7 @@ perf-kallsyms - Searches running kernel for symbols
 SYNOPSIS
 --------
 [verse]
-'perf kallsyms <options> symbol_name[,symbol_name...]'
+'perf kallsyms' [<options>] symbol_name[,symbol_name...]
 
 DESCRIPTION
 -----------
#4 lore raw
In reply to Sangwon Hong
perf kallsyms: Fix the usage on the man page
Commit-ID:  f6d3f35e006496c282ccbb67494d90b04f6cba10
Gitweb:     https://git.kernel.org/tip/f6d3f35e006496c282ccbb67494d90b04f6cba10
Author:     Sangwon Hong <[email protected]>
AuthorDate: Mon, 12 Feb 2018 04:37:44 +0900
Committer:  Arnaldo Carvalho de Melo <[email protected]>
CommitDate: Mon, 5 Mar 2018 11:48:37 -0300

perf kallsyms: Fix the usage on the man page

First, all man pages highlight only perf and subcommands except 'perf kallsyms', which includes the full usage. Fix it for commands to monopolize underlines.

Second, options can be ommited when executing 'perf kallsyms', so add square brackets between <option>.

---
 tools/perf/Documentation/perf-kallsyms.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
tools/perf/Documentation/perf-kallsyms.txt +1 -1
index 954ea9e21236..cf9f4040ea5c 100644
@@ -8,7 +8,7 @@ perf-kallsyms - Searches running kernel for symbols
 SYNOPSIS
 --------
 [verse]
-'perf kallsyms <options> symbol_name[,symbol_name...]'
+'perf kallsyms' [<options>] symbol_name[,symbol_name...]
 
 DESCRIPTION
 -----------