[PATCH 1/5] docs: move admin-guide/sysfs-rules.rst to userspace-api/

* [PATCH 1/5] docs: move admin-guide/sysfs-rules.rst to userspace-api/
@ 2024-01-04 16:09 Vegard Nossum
  2024-01-04 16:09 ` [PATCH 2/5] docs: move admin-guide/abi*.rst " Vegard Nossum
                   ` (4 more replies)
  0 siblings, 5 replies; 9+ messages in thread
From: Vegard Nossum @ 2024-01-04 16:09 UTC (permalink / raw)
  To: Jonathan Corbet
  Cc: Randy Dunlap, Mauro Carvalho Chehab, Greg Kroah-Hartman,
	Jani Nikula, linux-doc, linux-api, Vegard Nossum

This file documents how userspace ought to interact with sysfs. It is
clearly intended for applications that access sysfs programmatically,
rather than at users or admins.

Move it to the userspace API guide.

Cc: Mauro Carvalho Chehab <mchehab@kernel.org>
Signed-off-by: Vegard Nossum <vegard.nossum@oracle.com>
---
 Documentation/ABI/stable/sysfs-devices                 |  2 +-
 Documentation/admin-guide/index.rst                    |  9 ---------
 Documentation/userspace-api/index.rst                  | 10 +++++++++-
 .../{admin-guide => userspace-api}/sysfs-rules.rst     |  0
 tools/lib/api/fs/fs.c                                  |  2 +-
 5 files changed, 11 insertions(+), 12 deletions(-)
 rename Documentation/{admin-guide => userspace-api}/sysfs-rules.rst (100%)

diff --git a/Documentation/ABI/stable/sysfs-devices b/Documentation/ABI/stable/sysfs-devices
index 98a8ef99ac5f..7829414cba62 100644
--- a/Documentation/ABI/stable/sysfs-devices
+++ b/Documentation/ABI/stable/sysfs-devices
@@ -1,6 +1,6 @@
 Note:
   This documents additional properties of any device beyond what
-  is documented in Documentation/admin-guide/sysfs-rules.rst
+  is documented in Documentation/userspace-api/sysfs-rules.rst
 
 What:		/sys/devices/*/of_node
 Date:		February 2015
diff --git a/Documentation/admin-guide/index.rst b/Documentation/admin-guide/index.rst
index 43ea35613dfc..c2b032314a24 100644
--- a/Documentation/admin-guide/index.rst
+++ b/Documentation/admin-guide/index.rst
@@ -47,15 +47,6 @@ problems and bugs in particular.
    perf/index
    pstore-blk
 
-This is the beginning of a section with information of interest to
-application developers.  Documents covering various aspects of the kernel
-ABI will be found here.
-
-.. toctree::
-   :maxdepth: 1
-
-   sysfs-rules
-
 This is the beginning of a section with information of interest to
 application developers and system integrators doing analysis of the
 Linux kernel for safety critical applications. Documents supporting
diff --git a/Documentation/userspace-api/index.rst b/Documentation/userspace-api/index.rst
index 74bc0716432e..6ce2edf519f6 100644
--- a/Documentation/userspace-api/index.rst
+++ b/Documentation/userspace-api/index.rst
@@ -9,8 +9,16 @@ While much of the kernel's user-space API is documented elsewhere
 also be found in the kernel tree itself.  This manual is intended to be the
 place where this information is gathered.
 
+General documentation:
+
+.. toctree::
+   :maxdepth: 1
+
+   sysfs-rules
+
+Subsystem-specific documentation:
+
 .. toctree::
-   :caption: Table of contents
    :maxdepth: 2
 
    no_new_privs
diff --git a/Documentation/admin-guide/sysfs-rules.rst b/Documentation/userspace-api/sysfs-rules.rst
similarity index 100%
rename from Documentation/admin-guide/sysfs-rules.rst
rename to Documentation/userspace-api/sysfs-rules.rst
diff --git a/tools/lib/api/fs/fs.c b/tools/lib/api/fs/fs.c
index 5cb0eeec2c8a..c35247b6ad81 100644
--- a/tools/lib/api/fs/fs.c
+++ b/tools/lib/api/fs/fs.c
@@ -214,7 +214,7 @@ static void mem_toupper(char *f, size_t len)
 
 /*
  * Check for "NAME_PATH" environment variable to override fs location (for
- * testing). This matches the recommendation in Documentation/admin-guide/sysfs-rules.rst
+ * testing). This matches the recommendation in Documentation/userspace-api/sysfs-rules.rst
  * for SYSFS_PATH.
  */
 static bool fs__env_override(struct fs *fs)
-- 
2.34.1


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