linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH v1 3/3] docs: filesystems: sysfs: add remaining top level sysfs directory descriptions
@ 2025-09-02  2:30 Alex Tran
  2025-09-02  2:30 ` [PATCH v1 2/3] docs: filesystems: sysfs: clarify symlink destinations in dev and bus/devices descriptions Alex Tran
  2025-09-02  2:30 ` [PATCH v1 1/3] docs: filesystems: sysfs: remove top level sysfs net directory Alex Tran
  0 siblings, 2 replies; 3+ messages in thread
From: Alex Tran @ 2025-09-02  2:30 UTC (permalink / raw)
  To: corbet; +Cc: linux-doc, linux-kernel, Alex Tran

Finish top level sysfs directory descriptions for block, class, firmware,
hypervisor, kernel, and power. Did not write one for net directory. See
commit bc3a88431672 ("docs: filesystems: sysfs: remove top level sysfs net
 directory")


Signed-off-by: Alex Tran <alex.t.tran@gmail.com>
---
 Documentation/filesystems/sysfs.rst | 16 +++++++++++++++-
 1 file changed, 15 insertions(+), 1 deletion(-)

diff --git a/Documentation/filesystems/sysfs.rst b/Documentation/filesystems/sysfs.rst
index b562cfcda3d5..4b44b6af0688 100644
--- a/Documentation/filesystems/sysfs.rst
+++ b/Documentation/filesystems/sysfs.rst
@@ -334,8 +334,22 @@ a stat(2) operation.
 More information on driver-model specific features can be found in
 Documentation/driver-api/driver-model/.
 
+block/ contains symlinks to all the block devices discovered on the system.
+These symlinks point to directories under /sys/devices.
 
-TODO: Finish this section.
+class/ contains a directory for each device class, grouped by functional type.
+Each directory in class/ contains symlinks to devices in the /sys/devices directory.
+
+firmware/ contains system firmware data and configuration such as firmware tables,
+ACPI information, and device tree data.
+
+hypervisor/ contains virtualization platform information and provides an interface to
+the underlying hypervisor.  It is only present when running on a virtual machine.
+
+kernel/ contains runtime kernel parameters, configuration settings, and status.
+
+power/ contains power management subsystem information including
+sleep states, suspend/resume capabilities, and policies.
 
 
 Current Interfaces
-- 
2.51.0


^ permalink raw reply related	[flat|nested] 3+ messages in thread

* [PATCH v1 2/3] docs: filesystems: sysfs: clarify symlink destinations in dev and  bus/devices descriptions
  2025-09-02  2:30 [PATCH v1 3/3] docs: filesystems: sysfs: add remaining top level sysfs directory descriptions Alex Tran
@ 2025-09-02  2:30 ` Alex Tran
  2025-09-02  2:30 ` [PATCH v1 1/3] docs: filesystems: sysfs: remove top level sysfs net directory Alex Tran
  1 sibling, 0 replies; 3+ messages in thread
From: Alex Tran @ 2025-09-02  2:30 UTC (permalink / raw)
  To: corbet; +Cc: linux-doc, linux-kernel, Alex Tran

Change sysfs bus/devices and dev directory descriptions to
provide more verbose information about the specific symlink
destination the devices point to.

Signed-off-by: Alex Tran <alex.t.tran@gmail.com>
---
 Documentation/filesystems/sysfs.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/filesystems/sysfs.rst b/Documentation/filesystems/sysfs.rst
index c50da87f27fa..b562cfcda3d5 100644
--- a/Documentation/filesystems/sysfs.rst
+++ b/Documentation/filesystems/sysfs.rst
@@ -312,7 +312,7 @@ kernel. Each bus's directory contains two subdirectories::
 	drivers/
 
 devices/ contains symlinks for each device discovered in the system
-that point to the device's directory under root/.
+that point to the device's directory under /sys/devices.
 
 drivers/ contains a directory for each device driver that is loaded
 for devices on that particular bus (this assumes that drivers do not
@@ -327,7 +327,7 @@ loaded system modules, for both builtin and loadable modules.
 
 dev/ contains two directories: char/ and block/. Inside these two
 directories there are symlinks named <major>:<minor>.  These symlinks
-point to the sysfs directory for the given device.  /sys/dev provides a
+point to the directories under /sys/devices for each device.  /sys/dev provides a
 quick way to lookup the sysfs interface for a device from the result of
 a stat(2) operation.
 
-- 
2.51.0


^ permalink raw reply related	[flat|nested] 3+ messages in thread

* [PATCH v1 1/3] docs: filesystems: sysfs: remove top level sysfs net directory
  2025-09-02  2:30 [PATCH v1 3/3] docs: filesystems: sysfs: add remaining top level sysfs directory descriptions Alex Tran
  2025-09-02  2:30 ` [PATCH v1 2/3] docs: filesystems: sysfs: clarify symlink destinations in dev and bus/devices descriptions Alex Tran
@ 2025-09-02  2:30 ` Alex Tran
  1 sibling, 0 replies; 3+ messages in thread
From: Alex Tran @ 2025-09-02  2:30 UTC (permalink / raw)
  To: corbet; +Cc: linux-doc, linux-kernel, Alex Tran

The net/ directory is not present as a top level sysfs directory
in standard Linux systems. Network interfaces can be accessible
via /sys/class/net instead.

Signed-off-by: Alex Tran <alex.t.tran@gmail.com>
---
 Documentation/filesystems/sysfs.rst | 1 -
 1 file changed, 1 deletion(-)

diff --git a/Documentation/filesystems/sysfs.rst b/Documentation/filesystems/sysfs.rst
index c32993bc83c7..c50da87f27fa 100644
--- a/Documentation/filesystems/sysfs.rst
+++ b/Documentation/filesystems/sysfs.rst
@@ -299,7 +299,6 @@ The top level sysfs directory looks like::
     hypervisor/
     kernel/
     module/
-    net/
     power/
 
 devices/ contains a filesystem representation of the device tree. It maps
-- 
2.51.0


^ permalink raw reply related	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2025-09-02  2:30 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2025-09-02  2:30 [PATCH v1 3/3] docs: filesystems: sysfs: add remaining top level sysfs directory descriptions Alex Tran
2025-09-02  2:30 ` [PATCH v1 2/3] docs: filesystems: sysfs: clarify symlink destinations in dev and bus/devices descriptions Alex Tran
2025-09-02  2:30 ` [PATCH v1 1/3] docs: filesystems: sysfs: remove top level sysfs net directory Alex Tran

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).