Re: [PATCH v1 01/10] perf tools: Report itrace options in help

Jiri Olsa
2018-08-30T08:56:59Z

On Wed, Aug 29, 2018 at 10:18:25AM -0700, Andi Kleen wrote:

SNIP

> diff --git a/tools/perf/util/auxtrace.h b/tools/perf/util/auxtrace.h
> index e731f55da072..f3f7ad6ae202 100644
> --- a/tools/perf/util/auxtrace.h
> +++ b/tools/perf/util/auxtrace.h
> @@ -576,6 +576,23 @@ static inline void auxtrace__free(struct perf_session *session)
> return session->auxtrace->free(session);
> }
>
> +#define ITRACE_HELP \
> +" i synthesize instructions events\n" \
> +" b synthesize branches events\n" \
> +" c synthesize branches events (calls only)\n" \
> +" r synthesize branches events (returns only)\n" \
> +" x synthesize transactions events\n" \
> +" w synthesize ptwrite events\n" \
> +" p synthesize power events\n" \
> +" e synthesize error events\n" \
> +" d create a debug log\n" \
> +" g[len] synthesize a call chain (use with i or x)\n" \
> +" l[len] synthesize last branch entries (use with i or x)\n" \
> +" sNUMBER skip initial number of events\n" \
> +" PERIOD[ns|us|ms|i|t] specify period to sample stream\n" \
> +" concatenate multiple options. Default is ibxwpe\n"
> +
> +

Please align this a bit more (perf report usage) and add the ':'

--itrace[=<opts>]
Instruction Tracing options
i synthesize instructions events
b synthesize branches events
c synthesize branches events (calls only)
r synthesize branches events (returns only)
x synthesize transactions events
w synthesize ptwrite events
p synthesize power events
e synthesize error events
d create a debug log
g[len] synthesize a call chain (use with i or x)
l[len] synthesize last branch entries (use with i or x)
sNUMBER skip initial number of events
PERIOD[ns|us|ms|i|t] specify period to sample stream
concatenate multiple options. Default is ibxwpe

like for example for '-g' option:

-g, --call-graph <print_type,threshold[,print_limit],order,sort_key[,branch],value>
Display call graph (stack chain/backtrace):

print_type: call graph printing style (graph|flat|fractal|folded|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)
value: call graph value (percent|period|count)

Default: graph,0.5,caller,function,percent

jirka