[<prev] [next>] [<thread-prev] [day] [month] [year] [list]
Message-ID: <CAM9d7ch+AvG=NetiEjT6qmewhCy6+QEBS4sr1J7qikYnmQPDZg@mail.gmail.com>
Date: Tue, 8 Sep 2020 22:44:18 +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>,
linux-kernel <linux-kernel@...r.kernel.org>,
Ravi Bangoria <ravi.bangoria@...ux.ibm.com>
Subject: Re: [PATCH v2] Improve perf option help information in perf.txt
On Tue, Sep 8, 2020 at 8:16 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>
> ---
> 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..5edb854 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 absolute html path.
I doubt if we ever used this html man pages.
> +
> +-p::
> +--paginate::
> + Set up pager.
> +
> +--no-pager::
> + Add or change the content of environment variables.
It's too vague and incorrect. Maybe just "Do not set up pager" ?
Thanks
Namhyung
> +
> +--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
>
Powered by blists - more mailing lists