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

[Taeung Song]

On 01/21/2016 11:46 PM, Arnaldo Carvalho de Melo wrote:
> Em Fri, Jan 08, 2016 at 08:39:35PM +0900, Taeung Song escreveu:
> > Explain 'help.format' variables.
> >
> > Cc: Namhyung Kim <namhyung@xxxxxxxxxx>
> > Cc: Jiri Olsa <jolsa@xxxxxxxxxx>
> > Signed-off-by: Taeung Song <treeze.taeung@xxxxxxxxx>
> > ---
> >   tools/perf/Documentation/perf-config.txt | 4 ++++
> >   1 file changed, 4 insertions(+)
> >
> > diff --git a/tools/perf/Documentation/perf-config.txt b/tools/perf/Documentation/perf-config.txt
> > index 85b811f..aaf1791 100644
> > --- a/tools/perf/Documentation/perf-config.txt
> > +++ b/tools/perf/Documentation/perf-config.txt
> > @@ -278,6 +278,10 @@ annotate.*::
> >
> >   		99.93 â      mov    %eax,%eax
> >
> > +help.*::
> > +	help.format::
> > +		A format of manual page can be 'man' that is default.
> > +
>
> Huh? If this is the case, i.e. we have something that is configurable
> but admits only one option, maybe we should trow this alltogether and
> remove the need to document it? :-)

Hum.. I think so.

I tested config variables 'help.format' and 'man.viewer', again.
Selecting which manual page viewer can be done by both
this config variables.

So IMHO I think even if 'help.format' is removed,
it hasn't problem because this functionality is duplicated.
And I think it seems to be tidy that the whole 'help' section
is removed or just don't document it on perf-config doc.

Would I keep working on perf-config patchkit excluding 'help' section ?


Thanks,
Taeung