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

From: Namhyung Kim
Date: Tue Oct 20 2015 - 21:57:26 EST


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@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/