Re: [PATCH 1/3] perf help: Document missing options

From: Arnaldo Carvalho de Melo
Date: Mon Nov 13 2017 - 13:30:05 EST


Em Sun, Nov 12, 2017 at 10:10:45AM +0900, Sihyeon Jang escreveu:
> Cc: Jiri Olsa <jolsa@xxxxxxxxxx>
> Cc: Namhyung Kim <namhyung@xxxxxxxxxx>
> Signed-off-by: Sihyeon Jang <uneedsihyeon@xxxxxxxxx>
> ---
> tools/perf/Documentation/perf-help.txt | 14 +++++++++++++-
> 1 file changed, 13 insertions(+), 1 deletion(-)
>
> diff --git a/tools/perf/Documentation/perf-help.txt b/tools/perf/Documentation/perf-help.txt
> index 5143918..bb605af 100644
> --- a/tools/perf/Documentation/perf-help.txt
> +++ b/tools/perf/Documentation/perf-help.txt
> @@ -7,7 +7,7 @@ perf-help - display help information about perf
>
> SYNOPSIS
> --------
> -'perf help' [-a|--all] [COMMAND]
> +'perf help' [--all] [--man|--web|--info] [COMMAND]

Can you try figuring out if this actually works? I tried here and it
doesn't, its an area we took "for free" when we copied the initial
codebase from git.git, but I never looked at this area that much, now
that I try:

[acme@jouet linux]$ perf help
Config with no key for man viewer: childrenError: wrong config key-value pair top.children=true
[acme@jouet linux]$

Unsure if this is something that got broken by the 'perf config'
patches, Taeung?

- Arnaldo

> DESCRIPTION
> -----------
> @@ -33,6 +33,18 @@ OPTIONS
> Prints all the available commands on the standard output. This
> option supersedes any other option.
>
> +-i::
> +--info::
> + Shows info page.
> +
> +-m::
> +--man::
> + Shows man page.
> +
> +-w::
> +--web::
> + Shows manual in web browser.
> +
> PERF
> ----
> Part of the linkperf:perf[1] suite
> --
> 2.7.4