lkml.org 
[lkml]   [2009]   [Oct]   [19]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
Patch in this message
/
Date
From
SubjectRe: [PATCH 5/5] Documentation: ABI: document /sys/devices/system/cpu/
On Mon, 19 Oct 2009, Alex Chiang wrote:

> diff --git a/Documentation/ABI/testing/sysfs-devices-cpu b/Documentation/ABI/testing/sysfs-devices-cpu
> new file mode 100644
> index 0000000..9070889
> --- /dev/null
> +++ b/Documentation/ABI/testing/sysfs-devices-cpu

Shouldn't this be called sysfs-devices-system-cpu?

I see what you're doing: /sys/devices/system/node/* files are contained in
sysfs-devices-memory, but I think it would be helpful to have a more
strict naming scheme so that the contents of a sysfs directory are
described by a file of the same name.

> @@ -0,0 +1,42 @@
> +What: /sys/devices/system/cpu/
> +Date: October 2009
> +Contact: Linux kernel mailing list <linux-kernel@vger.kernel.org>
> +Description:
> + A collection of CPU attributes, including cache information,
> + topology, and frequency. It also contains a mechanism to
> + logically hotplug CPUs.
> +
> + The actual attributes present are architecture and
> + configuration dependent.
> +
> +
> +What: /sys/devices/system/cpu/$cpu/online
cpu# ?

> +Date: January 2006
> +Contact: Linux kernel mailing list <linux-kernel@vger.kernel.org>
> +Description:
> + When CONFIG_HOTPLUG_CPU is enabled, allows the user to
> + discover and change the online state of a CPU. To discover
> + the state:

This is present even without CONFIG_HOTPLUG_CPU.

> +
> + cat /sys/devices/system/cpu/$cpu/online
> +
> + A value of 0 indicates the CPU is offline. A value of 1
> + indicates it is online. To change the state, echo the
> + desired new state into the file:
> +
> + echo [0|1] > /sys/devices/system/cpu/$cpu/online
> +
> + For more information, please read Documentation/cpu-hotplug.txt
> +
> +
> +What: /sys/devices/system/cpu/$cpu/node
> +Date: October 2009
> +Contact: Linux memory management mailing list <linux-mm@kvack.org>
> +Description:
> + When CONFIG_NUMA is enabled, a symbolic link that points
> + to the corresponding NUMA node directory.
> +
> + For example, the following symlink is created for cpu42
> + in NUMA node 2:
> +
> + /sys/devices/system/cpu/cpu42/node2 -> ../../node/node2
>


Would it be possible for you to document all entities in
/sys/devices/system/cpu/* in this new file (requiring a folding of
Documentation/ABI/testing/sysfs-devices-cache_disable into it)?

\
 
 \ /
  Last update: 2009-10-20 05:31    [W:0.115 / U:0.080 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site