[PATCH] perf kallsyms: Fix the usage on the man page

linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed

* [PATCH] perf kallsyms: Fix the usage on the man page
@ 2018-02-11 19:37 Sangwon Hong
  2018-02-12  1:50 ` Namhyung Kim
                   ` (2 more replies)
  0 siblings, 3 replies; 5+ messages in thread
From: Sangwon Hong @ 2018-02-11 19:37 UTC (permalink / raw)
  To: Arnaldo Carvalho de Melo
  Cc: linux-kernel, Jiri Olsa, Namhyung Kim, Taeung Song, 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 <jolsa@kernel.org>
Cc: Namhyung Kim <namhyung@kernel.org>
Cc: Taeung Song <treeze.taeung@gmail.com>
Signed-off-by: Sangwon Hong <qpakzk@gmail.com>
---
 tools/perf/Documentation/perf-kallsyms.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/tools/perf/Documentation/perf-kallsyms.txt b/tools/perf/Documentation/perf-kallsyms.txt
index 954ea9e..cf9f404 100644
--- a/tools/perf/Documentation/perf-kallsyms.txt
+++ b/tools/perf/Documentation/perf-kallsyms.txt
@@ -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
 -----------
-- 
2.7.4

^ permalink raw reply related	[flat|nested] 5+ messages in thread

* Re: [PATCH] perf kallsyms: Fix the usage on the man page
  2018-02-11 19:37 [PATCH] perf kallsyms: Fix the usage on the man page Sangwon Hong
@ 2018-02-12  1:50 ` Namhyung Kim
  2018-02-21 12:25   ` Arnaldo Carvalho de Melo
  2018-03-06  6:40 ` [tip:perf/core] " tip-bot for Sangwon Hong
  2018-03-07  8:24 ` [tip:perf/urgent] " tip-bot for Sangwon Hong
  2 siblings, 1 reply; 5+ messages in thread
From: Namhyung Kim @ 2018-02-12  1:50 UTC (permalink / raw)
  To: Sangwon Hong
  Cc: Arnaldo Carvalho de Melo, linux-kernel, Jiri Olsa, Taeung Song,
	kernel-team

On Mon, Feb 12, 2018 at 04:37:44AM +0900, Sangwon Hong wrote:
> 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 <jolsa@kernel.org>
> Cc: Namhyung Kim <namhyung@kernel.org>
> Cc: Taeung Song <treeze.taeung@gmail.com>
> Signed-off-by: Sangwon Hong <qpakzk@gmail.com>

Acked-by: Namhyung Kim <namhyung@kernel.org>

Thanks,
Namhyung


> ---
>  tools/perf/Documentation/perf-kallsyms.txt | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/tools/perf/Documentation/perf-kallsyms.txt b/tools/perf/Documentation/perf-kallsyms.txt
> index 954ea9e..cf9f404 100644
> --- a/tools/perf/Documentation/perf-kallsyms.txt
> +++ b/tools/perf/Documentation/perf-kallsyms.txt
> @@ -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
>  -----------
> -- 
> 2.7.4
> 

^ permalink raw reply	[flat|nested] 5+ messages in thread

* Re: [PATCH] perf kallsyms: Fix the usage on the man page
  2018-02-12  1:50 ` Namhyung Kim
@ 2018-02-21 12:25   ` Arnaldo Carvalho de Melo
  0 siblings, 0 replies; 5+ messages in thread
From: Arnaldo Carvalho de Melo @ 2018-02-21 12:25 UTC (permalink / raw)
  To: Namhyung Kim
  Cc: Sangwon Hong, linux-kernel, Jiri Olsa, Taeung Song, kernel-team

Em Mon, Feb 12, 2018 at 10:50:21AM +0900, Namhyung Kim escreveu:
> On Mon, Feb 12, 2018 at 04:37:44AM +0900, Sangwon Hong wrote:
> > 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 <jolsa@kernel.org>
> > Cc: Namhyung Kim <namhyung@kernel.org>
> > Cc: Taeung Song <treeze.taeung@gmail.com>
> > Signed-off-by: Sangwon Hong <qpakzk@gmail.com>
> 
> Acked-by: Namhyung Kim <namhyung@kernel.org>

Thanks, applied.

- Arnaldo

^ permalink raw reply	[flat|nested] 5+ messages in thread

* [tip:perf/core] perf kallsyms: Fix the usage on the man page
  2018-02-11 19:37 [PATCH] perf kallsyms: Fix the usage on the man page Sangwon Hong
  2018-02-12  1:50 ` Namhyung Kim
@ 2018-03-06  6:40 ` tip-bot for Sangwon Hong
  2018-03-07  8:24 ` [tip:perf/urgent] " tip-bot for Sangwon Hong
  2 siblings, 0 replies; 5+ messages in thread
From: tip-bot for Sangwon Hong @ 2018-03-06  6:40 UTC (permalink / raw)
  To: linux-tip-commits
  Cc: namhyung, qpakzk, linux-kernel, mingo, jolsa, acme, treeze.taeung,
	hpa, tglx

Commit-ID:  de7112868829b3286def38297848d5d2592b4a70
Gitweb:     https://git.kernel.org/tip/de7112868829b3286def38297848d5d2592b4a70
Author:     Sangwon Hong <qpakzk@gmail.com>
AuthorDate: Mon, 12 Feb 2018 04:37:44 +0900
Committer:  Arnaldo Carvalho de Melo <acme@redhat.com>
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>.

Signed-off-by: Sangwon Hong <qpakzk@gmail.com>
Acked-by: Namhyung Kim <namhyung@kernel.org>
Cc: Jiri Olsa <jolsa@kernel.org>
Cc: Taeung Song <treeze.taeung@gmail.com>
Link: http://lkml.kernel.org/r/1518377864-20353-1-git-send-email-qpakzk@gmail.com
Signed-off-by: Arnaldo Carvalho de Melo <acme@redhat.com>
---
 tools/perf/Documentation/perf-kallsyms.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/tools/perf/Documentation/perf-kallsyms.txt b/tools/perf/Documentation/perf-kallsyms.txt
index 954ea9e21236..cf9f4040ea5c 100644
--- a/tools/perf/Documentation/perf-kallsyms.txt
+++ b/tools/perf/Documentation/perf-kallsyms.txt
@@ -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
 -----------

^ permalink raw reply related	[flat|nested] 5+ messages in thread

* [tip:perf/urgent] perf kallsyms: Fix the usage on the man page
  2018-02-11 19:37 [PATCH] perf kallsyms: Fix the usage on the man page Sangwon Hong
  2018-02-12  1:50 ` Namhyung Kim
  2018-03-06  6:40 ` [tip:perf/core] " tip-bot for Sangwon Hong
@ 2018-03-07  8:24 ` tip-bot for Sangwon Hong
  2 siblings, 0 replies; 5+ messages in thread
From: tip-bot for Sangwon Hong @ 2018-03-07  8:24 UTC (permalink / raw)
  To: linux-tip-commits
  Cc: namhyung, qpakzk, acme, linux-kernel, treeze.taeung, mingo, tglx,
	hpa, jolsa

Commit-ID:  f6d3f35e006496c282ccbb67494d90b04f6cba10
Gitweb:     https://git.kernel.org/tip/f6d3f35e006496c282ccbb67494d90b04f6cba10
Author:     Sangwon Hong <qpakzk@gmail.com>
AuthorDate: Mon, 12 Feb 2018 04:37:44 +0900
Committer:  Arnaldo Carvalho de Melo <acme@redhat.com>
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>.

Signed-off-by: Sangwon Hong <qpakzk@gmail.com>
Acked-by: Namhyung Kim <namhyung@kernel.org>
Cc: Jiri Olsa <jolsa@kernel.org>
Cc: Taeung Song <treeze.taeung@gmail.com>
Link: http://lkml.kernel.org/r/1518377864-20353-1-git-send-email-qpakzk@gmail.com
Signed-off-by: Arnaldo Carvalho de Melo <acme@redhat.com>
---
 tools/perf/Documentation/perf-kallsyms.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/tools/perf/Documentation/perf-kallsyms.txt b/tools/perf/Documentation/perf-kallsyms.txt
index 954ea9e21236..cf9f4040ea5c 100644
--- a/tools/perf/Documentation/perf-kallsyms.txt
+++ b/tools/perf/Documentation/perf-kallsyms.txt
@@ -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
 -----------

^ permalink raw reply related	[flat|nested] 5+ messages in thread

end of thread, other threads:[~2018-03-07  8:25 UTC | newest]

Thread overview: 5+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2018-02-11 19:37 [PATCH] perf kallsyms: Fix the usage on the man page Sangwon Hong
2018-02-12  1:50 ` Namhyung Kim
2018-02-21 12:25   ` Arnaldo Carvalho de Melo
2018-03-06  6:40 ` [tip:perf/core] " tip-bot for Sangwon Hong
2018-03-07  8:24 ` [tip:perf/urgent] " 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).