[PATCH 02/11] topolgy: simplify cputopology.txt formatting and wording

From: Len Brown
Date: Mon Feb 18 2019 - 22:41:19 EST


From: Len Brown <len.brown@xxxxxxxxx>

No semantic changes.

Signed-off-by: Len Brown <len.brown@xxxxxxxxx>
Cc: linux-doc@xxxxxxxxxxxxxxx
Signed-off-by: Len Brown <len.brown@xxxxxxxxx>
---
Documentation/cputopology.txt | 34 +++++++++++++++++-----------------
1 file changed, 17 insertions(+), 17 deletions(-)

diff --git a/Documentation/cputopology.txt b/Documentation/cputopology.txt
index c6e7e9196a8b..2698da7e4f49 100644
--- a/Documentation/cputopology.txt
+++ b/Documentation/cputopology.txt
@@ -3,76 +3,76 @@ How CPU topology info is exported via sysfs
===========================================

Export CPU topology info via sysfs. Items (attributes) are similar
-to /proc/cpuinfo output of some architectures:
+to /proc/cpuinfo output of some architectures. They reside in
+/sys/devices/system/cpu/cpuX/topology/:

-1) /sys/devices/system/cpu/cpuX/topology/physical_package_id:
+physical_package_id:

physical package id of cpuX. Typically corresponds to a physical
socket number, but the actual value is architecture and platform
dependent.

-2) /sys/devices/system/cpu/cpuX/topology/core_id:
+core_id:

the CPU core ID of cpuX. Typically it is the hardware platform's
identifier (rather than the kernel's). The actual value is
architecture and platform dependent.

-3) /sys/devices/system/cpu/cpuX/topology/book_id:
+book_id:

the book ID of cpuX. Typically it is the hardware platform's
identifier (rather than the kernel's). The actual value is
architecture and platform dependent.

-4) /sys/devices/system/cpu/cpuX/topology/drawer_id:
+drawer_id:

the drawer ID of cpuX. Typically it is the hardware platform's
identifier (rather than the kernel's). The actual value is
architecture and platform dependent.

-5) /sys/devices/system/cpu/cpuX/topology/thread_siblings:
+thread_siblings:

internal kernel map of cpuX's hardware threads within the same
core as cpuX.

-6) /sys/devices/system/cpu/cpuX/topology/thread_siblings_list:
+thread_siblings_list:

human-readable list of cpuX's hardware threads within the same
core as cpuX.

-7) /sys/devices/system/cpu/cpuX/topology/core_siblings:
+core_siblings:

internal kernel map of cpuX's hardware threads within the same
physical_package_id.

-8) /sys/devices/system/cpu/cpuX/topology/core_siblings_list:
+core_siblings_list:

human-readable list of cpuX's hardware threads within the same
physical_package_id.

-9) /sys/devices/system/cpu/cpuX/topology/book_siblings:
+book_siblings:

internal kernel map of cpuX's hardware threads within the same
book_id.

-10) /sys/devices/system/cpu/cpuX/topology/book_siblings_list:
+book_siblings_list:

human-readable list of cpuX's hardware threads within the same
book_id.

-11) /sys/devices/system/cpu/cpuX/topology/drawer_siblings:
+drawer_siblings:

internal kernel map of cpuX's hardware threads within the same
drawer_id.

-12) /sys/devices/system/cpu/cpuX/topology/drawer_siblings_list:
+drawer_siblings_list:

human-readable list of cpuX's hardware threads within the same
drawer_id.

-To implement it in an architecture-neutral way, a new source file,
-drivers/base/topology.c, is to export the 6 to 12 attributes. The book
-and drawer related sysfs files will only be created if CONFIG_SCHED_BOOK
-and CONFIG_SCHED_DRAWER are selected.
+Architecture-neutral, drivers/base/topology.c, exports these attributes.
+However, the book and drawer related sysfs files will only be created if
+CONFIG_SCHED_BOOK and CONFIG_SCHED_DRAWER are selected, respectively.

CONFIG_SCHED_BOOK and CONFIG_DRAWER are currently only used on s390, where
they reflect the cpu and cache hierarchy.
--
2.18.0-rc0