Re: [PATCH v11 07/24] perf config: Document variables for 'help' section in man page
From: Namhyung Kim
Date: Tue Nov 17 2015 - 19:45:37 EST
On Tue, Nov 17, 2015 at 10:53:27PM +0900, Taeung Song wrote:
> Explain 'help.format' and 'help.autocorrect' variables.
> Cc: Namhyung Kim <namhyung@xxxxxxxxxx>
> Cc: Jiri Olsa <jolsa@xxxxxxxxxx>
> Signed-off-by: Taeung Song <treeze.taeung@xxxxxxxxx>
> 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.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.
> SEE ALSO
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/