Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]


Groups > linux.kernel > #1250833 > unrolled thread

Re: [PATCH v2 1/3] perf help: Add options description to 'perf -h'

Started byNamhyung Kim <namhyung@kernel.org>
First post2015-10-19 17:30 +0200
Last post2015-10-21 04:00 +0200
Articles 3 — 2 participants

Back to article view | Back to linux.kernel

This discussion starts older than the indexed window; earlier articles aren't shown. The article labeled Started by below is the oldest one visible, not the original post.


Contents

  Re: [PATCH v2 1/3] perf help: Add options description to 'perf -h' Namhyung Kim <namhyung@kernel.org> - 2015-10-19 17:30 +0200
    Re: [PATCH v2 1/3] perf help: Add options description to 'perf -h' Yunlong Song <yunlong.song@huawei.com> - 2015-10-20 04:20 +0200
      Re: [PATCH v2 1/3] perf help: Add options description to 'perf -h' Namhyung Kim <namhyung@kernel.org> - 2015-10-21 04:00 +0200

#1250833 — Re: [PATCH v2 1/3] perf help: Add options description to 'perf -h'

FromNamhyung Kim <namhyung@kernel.org>
Date2015-10-19 17:30 +0200
SubjectRe: [PATCH v2 1/3] perf help: Add options description to 'perf -h'
Message-ID<qlkxQ-8qb-25@gated-at.bofh.it>
Hi,

On Thu, Oct 15, 2015 at 03:39:50PM +0800, Yunlong Song wrote:
> Add options description to 'perf -h' to make it consistent with other builtins
> (e.g., 'perf stat -h').
> 
> Example:
> 
> Before this patch:
> 
>  # perf -h
> 
>  usage: perf [--version] [--help] [OPTIONS] COMMAND [ARGS]
> 
>   The most commonly used perf commands are:
>     annotate        Read perf.data (created by perf record) and display annotated code
>     archive         Create archive with object files with build-ids found in perf.data file
>     bench           General framework for benchmark suites
>     buildid-cache   Manage build-id cache.
>     buildid-list    List the buildids in a perf.data file
>  <SNIP>
>     test            Runs sanity tests.
>     timechart       Tool to visualize total system behavior during a workload
>     top             System profiling tool.
>     trace           strace inspired tool
>     probe           Define new dynamic tracepoints
> 
>   See 'perf help COMMAND' for more information on a specific command.
> 
> After this patch:
> 
>  # perf -h
> 
>   usage: perf [--version] [--help] [OPTIONS] COMMAND [ARGS]
> 
>          --help            help
>          --version         version
>          --exec-path       exec-path
>          --html-path       html-path
>          --paginate        paginate
>          --no-pager        no-pager
>          --perf-dir        perf-dir
>          --work-tree       work-tree
>          --debugfs-dir     debugfs-dir
>          --buildid-dir     buildid-dir
>          --list-cmds       list-cmds
>          --list-opts       list-opts
>          --debug           debug

IMHO this *help* message is not very useful in its current form.  Also
please consider updating Documentation/perf.txt too.

Thanks,
Namhyung


> 
>   The most commonly used perf commands are:
>     annotate        Read perf.data (created by perf record) and display annotated code
>     archive         Create archive with object files with build-ids found in perf.data file
>     bench           General framework for benchmark suites
>     buildid-cache   Manage build-id cache.
>     buildid-list    List the buildids in a perf.data file
>  <SNIP>
>     test            Runs sanity tests.
>     timechart       Tool to visualize total system behavior during a workload
>     top             System profiling tool.
>     trace           strace inspired tool
>     probe           Define new dynamic tracepoints
> 
>   See 'perf help COMMAND' for more information on a specific command.
> 
> As shown above, the options description really appears now.
> 
> Signed-off-by: Yunlong Song <yunlong.song@huawei.com>
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/

[toc] | [next] | [standalone]


#1251261

FromYunlong Song <yunlong.song@huawei.com>
Date2015-10-20 04:20 +0200
Message-ID<qluGS-6D5-15@gated-at.bofh.it>
In reply to#1250833
On 2015/10/19 23:29, Namhyung Kim wrote:
> Hi,
> 
> On Thu, Oct 15, 2015 at 03:39:50PM +0800, Yunlong Song wrote:
>> Add options description to 'perf -h' to make it consistent with other builtins
>> (e.g., 'perf stat -h').
>>
>> Example:
>>
>> Before this patch:
>>
>>  # perf -h
>>
>>  usage: perf [--version] [--help] [OPTIONS] COMMAND [ARGS]
>>
>>   The most commonly used perf commands are:
>>     annotate        Read perf.data (created by perf record) and display annotated code
>>     archive         Create archive with object files with build-ids found in perf.data file
>>     bench           General framework for benchmark suites
>>     buildid-cache   Manage build-id cache.
>>     buildid-list    List the buildids in a perf.data file
>>  <SNIP>
>>     test            Runs sanity tests.
>>     timechart       Tool to visualize total system behavior during a workload
>>     top             System profiling tool.
>>     trace           strace inspired tool
>>     probe           Define new dynamic tracepoints
>>
>>   See 'perf help COMMAND' for more information on a specific command.
>>
>> After this patch:
>>
>>  # perf -h
>>
>>   usage: perf [--version] [--help] [OPTIONS] COMMAND [ARGS]
>>
>>          --help            help
>>          --version         version
>>          --exec-path       exec-path
>>          --html-path       html-path
>>          --paginate        paginate
>>          --no-pager        no-pager
>>          --perf-dir        perf-dir
>>          --work-tree       work-tree
>>          --debugfs-dir     debugfs-dir
>>          --buildid-dir     buildid-dir
>>          --list-cmds       list-cmds
>>          --list-opts       list-opts
>>          --debug           debug
> 
> IMHO this *help* message is not very useful in its current form.  Also
> please consider updating Documentation/perf.txt too.
> 
> Thanks,
> Namhyung

OK, I will update the struct option of perf to a more interpretative style soon.

> 
>>
>>   The most commonly used perf commands are:
>>     annotate        Read perf.data (created by perf record) and display annotated code
>>     archive         Create archive with object files with build-ids found in perf.data file
>>     bench           General framework for benchmark suites
>>     buildid-cache   Manage build-id cache.
>>     buildid-list    List the buildids in a perf.data file
>>  <SNIP>
>>     test            Runs sanity tests.
>>     timechart       Tool to visualize total system behavior during a workload
>>     top             System profiling tool.
>>     trace           strace inspired tool
>>     probe           Define new dynamic tracepoints
>>
>>   See 'perf help COMMAND' for more information on a specific command.
>>
>> As shown above, the options description really appears now.
>>
>> Signed-off-by: Yunlong Song <yunlong.song@huawei.com>
> 
> .
> 


-- 
Thanks,
Yunlong Song

--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/

[toc] | [prev] | [next] | [standalone]


#1252419

FromNamhyung Kim <namhyung@kernel.org>
Date2015-10-21 04:00 +0200
Message-ID<qlQR3-54h-5@gated-at.bofh.it>
In reply to#1251261
On Tue, Oct 20, 2015 at 10:13:17AM +0800, Yunlong Song wrote:
> On 2015/10/19 23:29, Namhyung Kim wrote:
> > Hi,
> > 
> > On Thu, Oct 15, 2015 at 03:39:50PM +0800, Yunlong Song wrote:
> >> Add options description to 'perf -h' to make it consistent with other builtins
> >> (e.g., 'perf stat -h').
> >>
> >> Example:
> >>
> >> Before this patch:
> >>
> >>  # perf -h
> >>
> >>  usage: perf [--version] [--help] [OPTIONS] COMMAND [ARGS]
> >>
> >>   The most commonly used perf commands are:
> >>     annotate        Read perf.data (created by perf record) and display annotated code
> >>     archive         Create archive with object files with build-ids found in perf.data file
> >>     bench           General framework for benchmark suites
> >>     buildid-cache   Manage build-id cache.
> >>     buildid-list    List the buildids in a perf.data file
> >>  <SNIP>
> >>     test            Runs sanity tests.
> >>     timechart       Tool to visualize total system behavior during a workload
> >>     top             System profiling tool.
> >>     trace           strace inspired tool
> >>     probe           Define new dynamic tracepoints
> >>
> >>   See 'perf help COMMAND' for more information on a specific command.
> >>
> >> After this patch:
> >>
> >>  # perf -h
> >>
> >>   usage: perf [--version] [--help] [OPTIONS] COMMAND [ARGS]
> >>
> >>          --help            help
> >>          --version         version
> >>          --exec-path       exec-path
> >>          --html-path       html-path
> >>          --paginate        paginate
> >>          --no-pager        no-pager
> >>          --perf-dir        perf-dir
> >>          --work-tree       work-tree
> >>          --debugfs-dir     debugfs-dir
> >>          --buildid-dir     buildid-dir
> >>          --list-cmds       list-cmds
> >>          --list-opts       list-opts
> >>          --debug           debug
> > 
> > IMHO this *help* message is not very useful in its current form.  Also
> > please consider updating Documentation/perf.txt too.
> > 
> > Thanks,
> > Namhyung
> 
> OK, I will update the struct option of perf to a more interpretative style soon.

In addition, --help and --version options are duplicate.  And I think
--perf-dir and --work-tree options are never used.  Also I doubt
anyone uses html help page with --html-path.  Finally I think it'd be
better to hide --list-cmds and --list-opts options as they're only
intended to be used by completion scripts.

Thanks,
Namhyung
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/

[toc] | [prev] | [standalone]


Back to top | Article view | linux.kernel


csiph-web