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

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:	Tue, 20 Oct 2015 00:29:25 +0900
From:	Namhyung Kim <namhyung@...nel.org>
To:	Yunlong Song <yunlong.song@...wei.com>
Cc:	a.p.zijlstra@...llo.nl, paulus@...ba.org, mingo@...hat.com,
	acme@...nel.org, linux-kernel@...r.kernel.org, wangnan0@...wei.com,
	artagnon@...il.com, sriram.r@...ia.com, adrian.hunter@...el.com,
	jolsa@...nel.org, dsahern@...il.com
Subject: Re: [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@...wei.com>
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@...r.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/