Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]


Groups > linux.kernel > #1271777

Re: [PATCH v11 07/24] perf config: Document variables for 'help' section in man page

From Namhyung Kim <namhyung@kernel.org>
Newsgroups linux.kernel
Subject Re: [PATCH v11 07/24] perf config: Document variables for 'help' section in man page
Date 2015-11-18 01:50 +0100
Message-ID <qvZ6F-3Vi-1@gated-at.bofh.it> (permalink)
References <qvTkC-f2-7@gated-at.bofh.it> <qvTkD-f2-31@gated-at.bofh.it>
Organization linux.* mail to news gateway

Show all headers | View raw


On Tue, Nov 17, 2015 at 10:53:27PM +0900, Taeung Song wrote:
> Explain 'help.format' and 'help.autocorrect' variables.
> 
> Cc: Namhyung Kim <namhyung@kernel.org>
> Cc: Jiri Olsa <jolsa@redhat.com>
> Signed-off-by: Taeung Song <treeze.taeung@gmail.com>
> ---
>  tools/perf/Documentation/perf-config.txt | 21 +++++++++++++++++++++
>  1 file changed, 21 insertions(+)
> 
> diff --git a/tools/perf/Documentation/perf-config.txt b/tools/perf/Documentation/perf-config.txt
> index bfbeb34..88e9b88 100644
> --- a/tools/perf/Documentation/perf-config.txt
> +++ b/tools/perf/Documentation/perf-config.txt
> @@ -242,6 +242,27 @@ annotate.*::
>  
>  		│1 1382:   movb   $0x1,-0x270(%rbp)
>  
> +help.*::
> +	help.format:: = man

What is this '= man' part?  Is it for default value?  It looks inconsistent anyway.


> +		A format of manual page can be 'man', 'info', 'web' or 'html'.
> +		'man' is default.

I don't know we support other format of manual pages.  Maybe asciidoc
does the job for us, but do we really care?  At least 'info' seems broken..


> +	help.autocorrect:: = 0
> +		Automatically correct and execute mistyped commands after
> +		waiting for the given number of deciseconds (0.1 sec).
> +		Let's see a example. If a mistyped sub-command is executed like 'perf mistyped-command'

s/a example/an example/

> +		and this option is 0, the output is as below.
> +
> +		perf: 'mistyped-command' is not a perf-command. See 'perf --help'.
> +
> +		Or if this option is more than 1, the output can be such as.
> +
> +		WARNING: You called a perf program named 'mistyped-command', which does not exist.
> +		Continuing under the assumption that you meant 'with-kcore'
> +		in 0.1 seconds automatically...
> +		Usage: perf-with-kcore <perf sub-command> <perf.data directory> [<sub-command options> [ -- <workload>]]
> +		<perf sub-command> can be record, script, report or inject
> +		    or: perf-with-kcore fix_buildid_cache_permissions

I wasn't aware of this feature and it seems completely broken.  If
it's a leftover from the git codebase, we'd better either to
disable/remove it or fix it.

Thanks,
Namhyung


> +
>  SEE ALSO
>  --------
>  linkperf:perf[1]
> -- 
> 1.9.1
> 
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/

Back to linux.kernel | Previous | NextPrevious in thread | Next in thread | Find similar | Unroll thread


Thread

[PATCH v11 01/24] perf tools: Add 'perf-config' command Taeung Song <treeze.taeung@gmail.com> - 2015-11-17 19:40 +0100
  [PATCH v11 22/24] perf config: Add 'set' feature Taeung Song <treeze.taeung@gmail.com> - 2015-11-17 19:40 +0100
  [PATCH v11 14/24] perf config: Document 'pager.<subcommand>' variables in man page Taeung Song <treeze.taeung@gmail.com> - 2015-11-17 19:40 +0100
    Re: [PATCH v11 14/24] perf config: Document 'pager.<subcommand>'  variables in man page Namhyung Kim <namhyung@kernel.org> - 2015-11-18 06:10 +0100
  [PATCH v11 19/24] perf config: Add a option 'skel' to perf-config Taeung Song <treeze.taeung@gmail.com> - 2015-11-17 19:40 +0100
  [PATCH v11 13/24] perf config: Document 'man.viewer' variable in man page Taeung Song <treeze.taeung@gmail.com> - 2015-11-17 19:40 +0100
    Re: [PATCH v11 13/24] perf config: Document 'man.viewer' variable in  man page Namhyung Kim <namhyung@kernel.org> - 2015-11-18 06:00 +0100
  [PATCH v11 07/24] perf config: Document variables for 'help' section in man page Taeung Song <treeze.taeung@gmail.com> - 2015-11-17 19:40 +0100
    Re: [PATCH v11 07/24] perf config: Document variables for 'help'  section in man page Namhyung Kim <namhyung@kernel.org> - 2015-11-18 01:50 +0100
  [PATCH v11 08/24] perf config: Document 'hist.percentage' variable in man page Taeung Song <treeze.taeung@gmail.com> - 2015-11-17 19:40 +0100
    Re: [PATCH v11 08/24] perf config: Document 'hist.percentage'  variable in man page Namhyung Kim <namhyung@kernel.org> - 2015-11-18 02:00 +0100
  [PATCH v11 18/24] perf config: Add 'list-all' option to perf-config Taeung Song <treeze.taeung@gmail.com> - 2015-11-17 19:40 +0100
  [PATCH v11 17/24] perf config: Collect configs to handle config variables Taeung Song <treeze.taeung@gmail.com> - 2015-11-17 19:40 +0100
    Re: [PATCH v11 17/24] perf config: Collect configs to handle config  variables Namhyung Kim <namhyung@kernel.org> - 2015-11-18 06:20 +0100
  [PATCH v11 16/24] perf config: Add '--system' and '--user' options to select which config file is used Taeung Song <treeze.taeung@gmail.com> - 2015-11-17 19:40 +0100
    Re: [PATCH v11 16/24] perf config: Add '--system' and '--user'  options to select which config file is used Namhyung Kim <namhyung@kernel.org> - 2015-11-18 06:20 +0100
  [PATCH v11 12/24] perf config: Document 'top.chidren' variable in man page Taeung Song <treeze.taeung@gmail.com> - 2015-11-17 19:40 +0100
    Re: [PATCH v11 12/24] perf config: Document 'top.chidren' variable  in man page Namhyung Kim <namhyung@kernel.org> - 2015-11-18 04:10 +0100
  [PATCH v11 11/24] perf config: Document variables for 'report' section in man page Taeung Song <treeze.taeung@gmail.com> - 2015-11-17 19:40 +0100
    Re: [PATCH v11 11/24] perf config: Document variables for 'report'  section in man page Namhyung Kim <namhyung@kernel.org> - 2015-11-18 04:10 +0100
  [PATCH v11 24/24] perf config: Add a option 'remove' to perf-config Taeung Song <treeze.taeung@gmail.com> - 2015-11-17 19:40 +0100
  [PATCH v11 23/24] perf config: normalize a value depending on default type of it Taeung Song <treeze.taeung@gmail.com> - 2015-11-17 19:40 +0100
  [PATCH v11 04/24] perf config: Document variables for 'tui' and 'gtk' sections in man page Taeung Song <treeze.taeung@gmail.com> - 2015-11-17 19:40 +0100
    Re: [PATCH v11 04/24] perf config: Document variables for 'tui' and  'gtk' sections in man page Namhyung Kim <namhyung@kernel.org> - 2015-11-18 01:10 +0100
  [PATCH v11 06/24] perf config: Document variables for 'annotate' section in man page Taeung Song <treeze.taeung@gmail.com> - 2015-11-17 19:40 +0100
    Re: [PATCH v11 06/24] perf config: Document variables for 'annotate'  section in man page Namhyung Kim <namhyung@kernel.org> - 2015-11-18 01:30 +0100
  [PATCH v11 10/24] perf config: Document variables for 'call-graph' section in man page Taeung Song <treeze.taeung@gmail.com> - 2015-11-17 19:40 +0100
    Re: [PATCH v11 10/24] perf config: Document variables for  'call-graph' section in man page Namhyung Kim <namhyung@kernel.org> - 2015-11-18 04:00 +0100
      Re: [PATCH v11 10/24] perf config: Document variables for 'call-graph' section in man page Taeung Song <treeze.taeung@gmail.com> - 2015-11-30 02:50 +0100
        Re: [PATCH v11 10/24] perf config: Document variables for  'call-graph' section in man page Namhyung Kim <namhyung@kernel.org> - 2015-11-30 06:10 +0100
  [PATCH v11 20/24] perf config: Add --verbose option for showing config description Taeung Song <treeze.taeung@gmail.com> - 2015-11-17 19:40 +0100
  [PATCH v11 03/24] perf config: Document variables for 'color' section in man page Taeung Song <treeze.taeung@gmail.com> - 2015-11-17 19:50 +0100
    Re: [PATCH v11 03/24] perf config: Document variables for 'color'  section in man page Namhyung Kim <namhyung@kernel.org> - 2015-11-18 00:50 +0100
  [PATCH v11 02/24] perf tools: Add perf-config document Taeung Song <treeze.taeung@gmail.com> - 2015-11-17 19:50 +0100
    Re: [PATCH v11 02/24] perf tools: Add perf-config document Namhyung Kim <namhyung@kernel.org> - 2015-11-18 00:20 +0100
      Re: [PATCH v11 02/24] perf tools: Add perf-config document Arnaldo Carvalho de Melo <acme@kernel.org> - 2015-11-19 20:30 +0100
        [PATCH v11 RESEND 02/24] perf tools: Add perf-config document Taeung Song <treeze.taeung@gmail.com> - 2015-11-22 11:20 +0100
          Re: [PATCH v11 RESEND 02/24] perf tools: Add perf-config document Arnaldo Carvalho de Melo <arnaldo.melo@gmail.com> - 2015-11-23 15:20 +0100
          [tip:perf/core] perf config: Add initial man page tip-bot for Taeung Song <tipbot@zytor.com> - 2015-11-26 09:30 +0100
        Re: [PATCH v11 02/24] perf tools: Add perf-config document Taeung Song <treeze.taeung@gmail.com> - 2015-11-22 11:20 +0100
  [PATCH v11 09/24] perf config: Document 'ui.show-headers' variable in man page Taeung Song <treeze.taeung@gmail.com> - 2015-11-17 19:50 +0100
    Re: [PATCH v11 09/24] perf config: Document 'ui.show-headers'  variable in man page Namhyung Kim <namhyung@kernel.org> - 2015-11-18 02:10 +0100
  [PATCH v11 05/24] perf config: Document 'buildid.dir' variable in man page Taeung Song <treeze.taeung@gmail.com> - 2015-11-17 19:50 +0100
    Re: [PATCH v11 05/24] perf config: Document 'buildid.dir' variable  in man page Namhyung Kim <namhyung@kernel.org> - 2015-11-18 01:10 +0100
  Re: [PATCH v11 01/24] perf tools: Add 'perf-config' command Namhyung Kim <namhyung@gmail.com> - 2015-11-17 23:40 +0100
  [tip:perf/core] perf tools: Add 'perf config' command tip-bot for Taeung Song <tipbot@zytor.com> - 2015-11-26 09:30 +0100

csiph-web