Re: perf: tools/perf/design.txt is badly out of date

From: Peter Zijlstra
Date: Fri Jun 04 2010 - 05:48:17 EST


On Thu, 2010-06-03 at 16:39 -0700, Corey Ashford wrote:
> I had a glance at tools/perf/design.txt the other day, and it
> appears to be pretty far out of date.
>
> Is design.txt a document that you want to keep the current way for
> historical reasons [and the up-to-date documentation placed somewhere
> else], or one that should be maintained?
>
> I'm wondering if some/all of this documentation should move into
> include/linux/perf_event.h

Its the ineffiteble fate of everything Documentation/ to be out-dated.
But yeah, that file will be woefully inaccurate by now.

Yeah, I think making perf_event.h more explanatory would be good. But I
don't think we want to go overboard there either, if comments get too
large and unwieldy they tend to bitrot just as hard as Documentation/


--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/