All of lore.kernel.org
 help / color / mirror / Atom feed
From: Alex Chiang <achiang@hp.com>
To: David Rientjes <rientjes@google.com>
Cc: Randy Dunlap <randy.dunlap@oracle.com>,
	Greg Kroah-Hartman <greg@kroah.com>,
	Andrew Morton <akpm@linux-foundation.org>,
	linux-kernel@vger.kernel.org
Subject: Re: [PATCH 0/7] Documentation: document /sys/devices/system/cpu/
Date: Thu, 22 Oct 2009 11:15:50 -0600	[thread overview]
Message-ID: <20091022171550.GC21728@ldl.fc.hp.com> (raw)
In-Reply-To: <alpine.DEB.2.00.0910220138380.9591@chino.kir.corp.google.com>

* David Rientjes <rientjes@google.com>:
> On Wed, 21 Oct 2009, Alex Chiang wrote:
> 
> > Hi Greg, Randy,
> > 
> > Not sure who actually maintains Documentation/ABI/; if it's not either of
> > y'all then please point me at the correct maintainer.
> > 
> > Anyhow, I was proposing some patches to enhance the NUMA sysfs interface:
> > 
> > 	http://thread.gmane.org/gmane.linux.kernel.mm/40084/
> > 
> > I documented my changes, but David Rientjes suggested that I take this
> > as an opportunity to do a more thorough job, so here is an attempt at
> > doing so by documenting at least the files that I saw on my system. Maybe
> > there are more that I didn't configure in, but I think this series covers
> > a good amount.
> > 
> 
> Fantastic, thanks Alex!
> 
> One thing I noticed in patches 3-6 of this series is you've attached 
> multiple files to a single "What:" line.  That hasn't been done before 
> (ignore the style violations of sysfs-firmware-*) and I think it would be 
> better to seperate each file out into its own section.

Ok, I can do that.

I was originally going for compactness, but I understand the
point you make below.

> I know it's long, but I think some automated scripts are eventually going 
> to use this documentation and it's best to follow the guidelines in 
> Documentation/ABI/README.

What do you think about keeping all the descriptions in the same
file, sysfs-devices-system-cpu vs. splitting them out into
separate files, sysfs-devices-system-cpu-topology, e.g.?

Will your tools be able to handle that?

Thanks.
/ac


  reply	other threads:[~2009-10-22 17:15 UTC|newest]

Thread overview: 19+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2009-10-22  3:45 [PATCH 0/7] Documentation: document /sys/devices/system/cpu/ Alex Chiang
2009-10-22  3:45 ` [PATCH 1/7] Documentation: ABI: rename sysfs-devices-cache_disable properly Alex Chiang
2009-10-22  8:45   ` David Rientjes
2009-10-22  3:45 ` [PATCH 2/7] Documentation: ABI: document /sys/devices/system/cpu/ Alex Chiang
2009-10-22  3:45 ` [PATCH 3/7] Documentation: ABI: /sys/devices/system/cpu/ topology files Alex Chiang
2009-10-28 21:15   ` David Rientjes
2009-10-28 21:23     ` Alex Chiang
2009-10-29  8:44       ` David Rientjes
2009-10-22  3:45 ` [PATCH 4/7] Documentation: ABI: /sys/devices/system/cpu/cpu#/ " Alex Chiang
2009-10-22  3:45 ` [PATCH 5/7] Documentation: ABI: /sys/devices/system/cpu/sched_[mc|smt]_power_savings Alex Chiang
2009-10-22  3:45 ` [PATCH 6/7] Documentation: ABI: /sys/devices/system/cpu/cpuidle/ Alex Chiang
2009-10-22  3:45 ` [PATCH 7/7] Documentation: ABI: /sys/devices/system/cpu/cpu#/cpufreq/ Alex Chiang
2009-10-22  8:42 ` [PATCH 0/7] Documentation: document /sys/devices/system/cpu/ David Rientjes
2009-10-22 17:15   ` Alex Chiang [this message]
2009-10-22 19:15     ` David Rientjes
2009-10-23  4:29   ` Greg KH
2009-10-23  9:28     ` David Rientjes
2009-10-22 21:45 ` Randy Dunlap
2009-10-23  4:29   ` Greg KH

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=20091022171550.GC21728@ldl.fc.hp.com \
    --to=achiang@hp.com \
    --cc=akpm@linux-foundation.org \
    --cc=greg@kroah.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=randy.dunlap@oracle.com \
    --cc=rientjes@google.com \
    /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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.