Re: perf: "Longum est iter per praecepta, breve et efficax per exempla"

Ingo Molnar
2009-08-06T09:11:19Z

* Carlos R. Mafra <crmafra2@gmail.com> wrote:

> Hi Pekka,
>
> On Thu 6.Aug'09 at 10:08:44 +0300, Pekka Enberg wrote:
> > Hi Carlos,
> >
> > On Wed, Aug 5, 2009 at 9:53 PM, Carlos R. Mafra<crmafra2@gmail.com> wrote:
> > > A few examples of how 'perf' can be used, from an e-mail by
> > > Ingo Molnar http://lkml.org/lkml/2009/8/4/346.
> > >
> > > Signed-off-by: Carlos R. Mafra <crmafra2@gmail.com>
> > > ---
> > >
> > > This "patch" is my way of _suggesting_ some "documentation by examples"
> > > of what 'perf' can do to the guys who can really write it :-)
> >
> > I was also looking for a perf "cookbook" and Ingo suggested we should
> > put this stuff on the kernel.org wiki:
> >
> > http://perf.wiki.kernel.org/index.php/Main_Page
> >
> > How about just putting the email there?
>
> First of all I just would like to rephrase my comment in the
> patch.
>
> It was not meant to be a suggestion for Ingo to write more
> documentation per se, it was my way of pointing out that such
> "documentation" is useful for beginners and that I, as Valdis,
> appreciated reading it. So it was more of a "keep coming" and
> don't rephrain from writing these examples in the e-mails kind of
> thing.

yeah, that's very useful to newbies, i agree.

I'm not very good at coming up with examples for beginners myself
(probably partly because i'm already across the learning curve and
partly because i wrote portions of it so it's 'obvious' to my own
subjective experience) - so help is welcome.

Another area that could be improved is to make the screen that comes
up when 'perf' is typed a bit more self-explanatory. Maybe print the
URL to your "Beginner's Page" wiki page in that place?

Patches are much welcome for that area as well, of course.

> Now about the wiki. Yeah, that sounds great and I didn't know
> about it yesterday. It will be nice if the wiki becomes a place
> where people can look for such usage examples.

Thanks,

Ingo