Re: [PATCH v13 04/23] perf config: Document variables for 'annotate' section in man page

[Taeung Song]

Hi, Arnaldo

Sorry for my tardy response.

On 01/21/2016 11:45 PM, Arnaldo Carvalho de Melo wrote:
> Em Fri, Jan 08, 2016 at 08:39:34PM +0900, Taeung Song escreveu:
> > Explain 'annotate' section and its variables.
> >
> > 'hide_src_code', 'use_offset', 'jump_arrows',
> > 'show_linenr', 'show_nr_jump' and 'show_total_period'.
> >
> > Cc: Namhyung Kim <namhyung@xxxxxxxxxx>
> > Cc: Jiri Olsa <jolsa@xxxxxxxxxx>
> > Signed-off-by: Taeung Song <treeze.taeung@xxxxxxxxx>
> > ---
> >   tools/perf/Documentation/perf-config.txt | 110 +++++++++++++++++++++++++++++++
> >   1 file changed, 110 insertions(+)
> >
> > diff --git a/tools/perf/Documentation/perf-config.txt b/tools/perf/Documentation/perf-config.txt
> > index 8835215..85b811f 100644
> > --- a/tools/perf/Documentation/perf-config.txt
> > +++ b/tools/perf/Documentation/perf-config.txt
> > @@ -168,6 +168,116 @@ buildid.*::
> >   		cache location, or to disable it altogether. If you want to disable it,
> >   		set buildid.dir to /dev/null. The default is $HOME/.debug
>
> I suggest you document here also the hotkeys that are available in the
> TUI to toggle those knobs, i.e. please go to the annotate browser and
> press 'h', you'll get the list of hotkeys, this way, for someone reading
> the man page the information will know that this can be done
> interactively, not just by changing a config file.

I don't know whether this patch was applied
as it is, because of my tardy response or not..
I saw this patch was included in [GIT PULL] mail.

Would you mind if I add this hotkeys information
into perf-config documentation as new patchset ?

> Also it would be interesting to change the annotate/top/report man page
> to point to this documentation.

Ok, I understood that add 'linkperf:perf-config[1]' to section
'SEE ALSO' on the annotate/top/report man page.
Is it right ?

If it isn't, add a sentence such as
'Please refer to the perf-config manual.'
to the annotate/top/report documentation ?

> But this can be done on top, I'm doing quick text flowing/grammar fixes
> and applying as much as I can from this patchkit, thanks for continuing
> work on it.

Although it is a minor contribution,
I'm so glad I could contribute. :-)

Thanks,
Taeung