All of lore.kernel.org
 help / color / mirror / Atom feed
* [PATCH v3] Improve perf option help information in perf.txt
@ 2020-09-09  9:53 Zejiang Tang
  2020-09-09 13:03 ` Namhyung Kim
  0 siblings, 1 reply; 3+ messages in thread
From: Zejiang Tang @ 2020-09-09  9:53 UTC (permalink / raw)
  To: Peter Zijlstra, Ingo Molnar, Arnaldo Carvalho de Melo
  Cc: Mark Rutland, Alexander Shishkin, Jiri Olsa, Namhyung Kim,
	Ravi Bangoria, linux-kernel

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@loongson.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..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


^ permalink raw reply related	[flat|nested] 3+ messages in thread

* Re: [PATCH v3] Improve perf option help information in perf.txt
  2020-09-09  9:53 [PATCH v3] Improve perf option help information in perf.txt Zejiang Tang
@ 2020-09-09 13:03 ` Namhyung Kim
  2020-09-17 19:04   ` Arnaldo Carvalho de Melo
  0 siblings, 1 reply; 3+ messages in thread
From: Namhyung Kim @ 2020-09-09 13:03 UTC (permalink / raw)
  To: Zejiang Tang
  Cc: Peter Zijlstra, Ingo Molnar, Arnaldo Carvalho de Melo,
	Mark Rutland, Alexander Shishkin, Jiri Olsa, Ravi Bangoria,
	linux-kernel

On Wed, Sep 9, 2020 at 6:53 PM Zejiang Tang <tangzejiang@loongson.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@loongson.cn>

Acked-by: Namhyung Kim <namhyung@kernel.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
>

^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: [PATCH v3] Improve perf option help information in perf.txt
  2020-09-09 13:03 ` Namhyung Kim
@ 2020-09-17 19:04   ` Arnaldo Carvalho de Melo
  0 siblings, 0 replies; 3+ messages in thread
From: Arnaldo Carvalho de Melo @ 2020-09-17 19:04 UTC (permalink / raw)
  To: Namhyung Kim
  Cc: Zejiang Tang, Peter Zijlstra, Ingo Molnar, Mark Rutland,
	Alexander Shishkin, Jiri Olsa, Ravi Bangoria, linux-kernel

Em Wed, Sep 09, 2020 at 10:03:34PM +0900, Namhyung Kim escreveu:
> On Wed, Sep 9, 2020 at 6:53 PM Zejiang Tang <tangzejiang@loongson.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@loongson.cn>
> 
> Acked-by: Namhyung Kim <namhyung@kernel.org>

Thanks, applied.

- Arnaldo

 
> 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
> >

-- 

- Arnaldo

^ permalink raw reply	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2020-09-17 19:05 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2020-09-09  9:53 [PATCH v3] Improve perf option help information in perf.txt Zejiang Tang
2020-09-09 13:03 ` Namhyung Kim
2020-09-17 19:04   ` Arnaldo Carvalho de Melo

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.