public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
From: Corey Ashford <cjashfor@linux.vnet.ibm.com>
To: Peter Zijlstra <peterz@infradead.org>
Cc: LKML <linux-kernel@vger.kernel.org>, Ingo Molnar <mingo@elte.hu>,
	Arnaldo Carvalho de Melo <acme@redhat.com>
Subject: Re: perf: tools/perf/design.txt is badly out of date
Date: Fri, 04 Jun 2010 10:10:22 -0700	[thread overview]
Message-ID: <4C09337E.3070504@linux.vnet.ibm.com> (raw)
In-Reply-To: <1275644908.27810.39476.camel@twins>

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@us.ibm.com

      reply	other threads:[~2010-06-04 17:10 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2010-06-03 23:39 perf: tools/perf/design.txt is badly out of date Corey Ashford
2010-06-04  9:48 ` Peter Zijlstra
2010-06-04 17:10   ` Corey Ashford [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=4C09337E.3070504@linux.vnet.ibm.com \
    --to=cjashfor@linux.vnet.ibm.com \
    --cc=acme@redhat.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mingo@elte.hu \
    --cc=peterz@infradead.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox