lkml.org 
[lkml]   [2015]   [Oct]   [19]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
From
SubjectRe: [PATCH v2 1/3] perf help: Add options description to 'perf -h'
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>


\
 
 \ /
  Last update: 2015-10-19 17:41    [W:0.230 / U:0.676 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site