Re: [PATCH] perf_counters: start documenting HAVE_PERF_COUNTERS requirements

[Sam Ravnborg <sam@ravnborg.org>]

On Fri, Jun 12, 2009 at 10:40:50AM -0700, Randy Dunlap wrote:
> Mike Frysinger wrote:
> > On Fri, Jun 12, 2009 at 13:36, Ingo Molnar wrote:
> >> * Mike Frysinger <vapier.adi@gmail.com> wrote:
> >>> On Fri, Jun 12, 2009 at 13:30, Ingo Molnar wrote:
> >>>> * Mike Frysinger <vapier@gentoo.org> wrote:
> >>>>> Help out arch porters who want to support perf counters by listing some
> >>>>> basic requirements.
> >>>>>
> >>>>> Signed-off-by: Mike Frysinger <vapier@gentoo.org>
> >>>>> ---
> >>>>> i imagine more details would be good, but this is a starting point and
> >>>>> better than nothing
> >>>>>
> >>>>>  init/Kconfig          |    2 ++
> >>>>>  tools/perf/design.txt |   15 +++++++++++++++
> >>>>>  2 files changed, 17 insertions(+), 0 deletions(-)
> >>>>>
> >>>>> diff --git a/init/Kconfig b/init/Kconfig
> >>>>> index c649657..20f85b1 100644
> >>>>> --- a/init/Kconfig
> >>>>> +++ b/init/Kconfig
> >>>>> @@ -936,6 +936,8 @@ config AIO
> >>>>>
> >>>>>  config HAVE_PERF_COUNTERS
> >>>>>       bool
> >>>>> +     help
> >>>>> +       See end of tools/perf/design.txt
> >>>>>
> >>>>>  menu "Performance Counters"
> >>>> Applied, thanks Mike! I have made a small change: i changed it from
> >>>> help text into a regular comment. We usually use help texts for
> >>>> interactive Kconfig options - but this is not one.
> >>> yes, but i like the help text because when i use the kconfig
> >>> search option, it shows up.  otherwise doing a search for
> >>> HAVE_PERF_COUNTERS shows nothing useful.
> >> When i did this modification i tried that in 'make menuconfig' and
> >> the help didnt show up. Is it only available in certain kconfig
> >> methods?
> 
> There is no prompt string for it, so it's invisible in menuconfig.
> xconfig has View options that can show it.
> 
> > hrm, you're right.  not sure what i was thinking of.  sounds like an
> > enhancement request though for kconfig.
> 
> Could be.  Cc: Sam added.

We do not want to show the invisible symbols.
But the added help text is still fine as it is there when you
grep the Kconfig file.

	Sam