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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <4C09337E.3070504@linux.vnet.ibm.com>
Date:	Fri, 04 Jun 2010 10:10:22 -0700
From:	Corey Ashford <cjashfor@...ux.vnet.ibm.com>
To:	Peter Zijlstra <peterz@...radead.org>
CC:	LKML <linux-kernel@...r.kernel.org>, Ingo Molnar <mingo@...e.hu>,
	Arnaldo Carvalho de Melo <acme@...hat.com>
Subject: Re: perf: tools/perf/design.txt is badly out of date

Maybe the file should at least move to the normal burial ground for docs, Documentation, rather than where it is today tools/perf.  Perhaps there it would be easier for people to find and correct.

On 6/4/2010 2:48 AM, Peter Zijlstra wrote:
> 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/
> 
> 

-- 
Regards,

- Corey

Corey Ashford
Software Engineer
IBM Linux Technology Center, Linux Toolchain
Beaverton, OR 
503-578-3507 
cjashfor@...ibm.com
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@...r.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/