linux-kernel - Re: [PATCH v3] Improve perf option help information in perf.txt

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Date:   Wed, 9 Sep 2020 22:03:34 +0900
From:   Namhyung Kim <namhyung@...nel.org>
To:     Zejiang Tang <tangzejiang@...ngson.cn>
Cc:     Peter Zijlstra <peterz@...radead.org>,
        Ingo Molnar <mingo@...hat.com>,
        Arnaldo Carvalho de Melo <acme@...nel.org>,
        Mark Rutland <mark.rutland@....com>,
        Alexander Shishkin <alexander.shishkin@...ux.intel.com>,
        Jiri Olsa <jolsa@...hat.com>,
        Ravi Bangoria <ravi.bangoria@...ux.ibm.com>,
        linux-kernel <linux-kernel@...r.kernel.org>
Subject: Re: [PATCH v3] Improve perf option help information in perf.txt

On Wed, Sep 9, 2020 at 6:53 PM Zejiang Tang <tangzejiang@...ngson.cn> wrote:
>
> Perf could use many options, such as:-vv, --exec-path,
> --html-path, -p, --paginate,--no-pager, --debugfs-dir,
> --buildid-dir, --list-cmds, --list-opts. Add these options
> in perf.txt.
>
> Signed-off-by: Zejiang Tang <tangzejiang@...ngson.cn>

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

Thanks
Namhyung


> ---
>  tools/perf/Documentation/perf.txt | 69 ++++++++++++++++++++++++++-------------
>  1 file changed, 47 insertions(+), 22 deletions(-)
>
> diff --git a/tools/perf/Documentation/perf.txt b/tools/perf/Documentation/perf.txt
> index 3f37ded..c130a3c 100644
> --- a/tools/perf/Documentation/perf.txt
> +++ b/tools/perf/Documentation/perf.txt
> @@ -12,32 +12,57 @@ SYNOPSIS
>
>  OPTIONS
>  -------
> ---debug::
> -       Setup debug variable (see list below) in value
> -       range (0, 10). Use like:
> -         --debug verbose   # sets verbose = 1
> -         --debug verbose=2 # sets verbose = 2
> -
> -       List of debug variables allowed to set:
> -         verbose          - general debug messages
> -         ordered-events   - ordered events object debug messages
> -         data-convert     - data convert command debug messages
> -         stderr           - write debug output (option -v) to stderr
> -                            in browser mode
> -         perf-event-open  - Print perf_event_open() arguments and
> -                            return value
> -
> ---buildid-dir::
> -       Setup buildid cache directory. It has higher priority than
> -       buildid.dir config file option.
> +-h::
> +--help::
> +        Run perf help command.
>
>  -v::
>  --version::
> -  Display perf version.
> +        Display perf version.
>
> --h::
> ---help::
> -  Run perf help command.
> +-vv::
> +        Print the compiled-in status of libraries.
> +
> +--exec-path::
> +        Display or set exec path.
> +
> +--html-path::
> +        Display html documentation path.
> +
> +-p::
> +--paginate::
> +        Set up pager.
> +
> +--no-pager::
> +        Do not set pager.
> +
> +--buildid-dir::
> +        Setup buildid cache directory. It has higher priority
> +        than buildid.dir config file option.
> +
> +--list-cmds::
> +        List the most commonly used perf commands.
> +
> +--list-opts::
> +        List available perf options.
> +
> +--debugfs-dir::
> +        Set debugfs directory or set environment variable PERF_DEBUGFS_DIR.
> +
> +--debug::
> +        Setup debug variable (see list below) in value
> +        range (0, 10). Use like:
> +          --debug verbose   # sets verbose = 1
> +          --debug verbose=2 # sets verbose = 2
> +
> +        List of debug variables allowed to set:
> +          verbose          - general debug messages
> +          ordered-events   - ordered events object debug messages
> +          data-convert     - data convert command debug messages
> +          stderr           - write debug output (option -v) to stderr
> +                             in browser mode
> +          perf-event-open  - Print perf_event_open() arguments and
> +                             return value
>
>  DESCRIPTION
>  -----------
> --
> 2.1.0
>