From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1752699AbbJUB5X (ORCPT ); Tue, 20 Oct 2015 21:57:23 -0400 Received: from mail-pa0-f45.google.com ([209.85.220.45]:33985 "EHLO mail-pa0-f45.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1752084AbbJUB5W (ORCPT ); Tue, 20 Oct 2015 21:57:22 -0400 Date: Wed, 21 Oct 2015 10:57:14 +0900 From: Namhyung Kim To: Yunlong Song Cc: a.p.zijlstra@chello.nl, paulus@samba.org, mingo@redhat.com, acme@kernel.org, linux-kernel@vger.kernel.org, wangnan0@huawei.com, artagnon@gmail.com, sriram.r@nokia.com, adrian.hunter@intel.com, jolsa@kernel.org, dsahern@gmail.com Subject: Re: [PATCH v2 1/3] perf help: Add options description to 'perf -h' Message-ID: <20151021015714.GC628@sejong> References: <20151014031043.GA3775@kernel.org> <1444894792-2338-1-git-send-email-yunlong.song@huawei.com> <1444894792-2338-2-git-send-email-yunlong.song@huawei.com> <20151019152925.GC14297@danjae.kornet> <5625A33D.8070001@huawei.com> MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Disposition: inline In-Reply-To: <5625A33D.8070001@huawei.com> User-Agent: Mutt/1.5.24 (2015-08-30) Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org 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 > >> > >> 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