linux-kernel - Re: [tip:perf/core] perf tools: Improve call graph documents and help messages

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] [day] [month] [year] [list]

Message-ID: <20151025091915.GA4380@gmail.com>
Date:	Sun, 25 Oct 2015 10:19:15 +0100
From:	Ingo Molnar <mingo@...nel.org>
To:	Namhyung Kim <namhyung@...nel.org>
Cc:	Thomas Gleixner <tglx@...utronix.de>, "bp@...e.de" <bp@...e.de>,
	Wang Nan <wangnan0@...wei.com>,
	David Ahern <dsahern@...il.com>,
	"H. Peter Anvin" <hpa@...or.com>,
	"linux-kernel@...r.kernel.org" <linux-kernel@...r.kernel.org>,
	Arnaldo Carvalho de Melo <acme@...hat.com>,
	Jiri Olsa <jolsa@...hat.com>,
	Chandler Carruth <chandlerc@...il.com>,
	Adrian Hunter <adrian.hunter@...el.com>,
	Peter Zijlstra <a.p.zijlstra@...llo.nl>,
	Stephane Eranian <eranian@...gle.com>,
	Brendan Gregg <brendan.d.gregg@...il.com>,
	Frédéric Weisbecker <fweisbec@...il.com>,
	linux-tip-commits@...r.kernel.org
Subject: Re: [tip:perf/core] perf tools: Improve call graph documents and
 help messages


* Namhyung Kim <namhyung@...nel.org> wrote:

> Hi Ingo,
> 
> On Fri, Oct 23, 2015 at 6:03 PM, Ingo Molnar <mingo@...nel.org> wrote:
> >
> > * tip-bot for Namhyung Kim <tipbot@...or.com> wrote:
> >
> >> Commit-ID:  76a26549eb367f683fbb394b7246bef5dc665f8c
> >> Gitweb:     http://git.kernel.org/tip/76a26549eb367f683fbb394b7246bef5dc665f8c
> >> Author:     Namhyung Kim <namhyung@...nel.org>
> >> AuthorDate: Thu, 22 Oct 2015 23:28:32 +0900
> >> Committer:  Arnaldo Carvalho de Melo <acme@...hat.com>
> >> CommitDate: Thu, 22 Oct 2015 16:23:19 -0300
> >>
> >> perf tools: Improve call graph documents and help messages
> >>
> >> The --call-graph option is complex so we should provide better guide for
> >> users.  Also change help message to be consistent with config option
> >> names.  Now perf top will show help like below:
> >>
> >>   $ perf top --call-graph
> >>     Error: option `call-graph' requires a value
> >>
> >>    Usage: perf top [<options>]
> >>
> >>       --call-graph <record_mode[,record_size],print_type,threshold[,print_limit],order,sort_key[,branch]>
> >>            setup and enables call-graph (stack chain/backtrace):
> >>
> >>               record_mode:    call graph recording mode (fp|dwarf|lbr)
> >>               record_size:    if record_mode is 'dwarf', max size of stack recording (<bytes>)
> >>                               default: 8192 (bytes)
> >>               print_type:     call graph printing style (graph|flat|fractal|none)
> >>               threshold:      minimum call graph inclusion threshold (<percent>)
> >>               print_limit:    maximum number of call graph entry (<number>)
> >>               order:          call graph order (caller|callee)
> >>               sort_key:       call graph sort key (function|address)
> >>               branch:         include last branch info to call graph (branch)
> >
> > Btw., how is the last line to be interpreted? Is the 'branch' value 0/1? If yes
> > then the text should probably say so? Or does the string 'branch' have to be used?
> 
> Yep, the string 'branch' should be used.

Yeah, so that wasn't very obvious, as there's a mixture of literal symbols with 
parameter names. For example:

       --call-graph <record_mode[,record_size],print_type,threshold[,print_limit],order,sort_key[,branch]>
            setup and enables call-graph (stack chain/backtrace):

so 'record_size' is obviously never to be written in a literal fashion - but 
'branch' is?

But I cannot think of a better solution, other than replacing:

                              default: 8192 (bytes)

with :
                              default: 8192 bytes

because in all other cases parantheses denote a specification of valid parameter 
values.

Thanks,

	Ingo
--
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/