linux-kernel - [PATCH 3/7] Documentation: gpio: update sysfs documentation to reference new chardev doc

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Date: Tue,  9 Jan 2024 21:59:48 +0800
From: Kent Gibson <warthog618@...il.com>
To: linux-kernel@...r.kernel.org,
	linux-gpio@...r.kernel.org,
	linux-doc@...r.kernel.org,
	brgl@...ev.pl,
	linus.walleij@...aro.org,
	andy@...nel.org,
	corbet@....net
Cc: Kent Gibson <warthog618@...il.com>
Subject: [PATCH 3/7] Documentation: gpio: update sysfs documentation to reference new chardev doc

Update GPIO sysfs interface documentation to reference the new
chardev document rather than gpio.h.

Signed-off-by: Kent Gibson <warthog618@...il.com>
---
 Documentation/userspace-api/gpio/sysfs.rst | 10 ++++------
 1 file changed, 4 insertions(+), 6 deletions(-)

diff --git a/Documentation/userspace-api/gpio/sysfs.rst b/Documentation/userspace-api/gpio/sysfs.rst
index 35171d15f78d..ef080d811451 100644
--- a/Documentation/userspace-api/gpio/sysfs.rst
+++ b/Documentation/userspace-api/gpio/sysfs.rst
@@ -5,12 +5,10 @@ GPIO Sysfs Interface for Userspace
 
   THIS ABI IS DEPRECATED, THE ABI DOCUMENTATION HAS BEEN MOVED TO
   Documentation/ABI/obsolete/sysfs-gpio AND NEW USERSPACE CONSUMERS
-  ARE SUPPOSED TO USE THE CHARACTER DEVICE ABI. THIS OLD SYSFS ABI WILL
-  NOT BE DEVELOPED (NO NEW FEATURES), IT WILL JUST BE MAINTAINED.
+  SHOULD USE THE chardev.rst.
 
-Refer to the examples in tools/gpio/* for an introduction to the new
-character device ABI. Also see the userspace header in
-include/uapi/linux/gpio.h
+  THIS OLD SYSFS ABI WILL NOT BE DEVELOPED (NO NEW FEATURES), IT WILL JUST BE
+  MAINTAINED.
 
 The deprecated sysfs ABI
 ------------------------
@@ -34,7 +32,7 @@ standard kernels won't know about. And for some tasks, simple userspace
 GPIO drivers could be all that the system really needs.
 
 DO NOT ABUSE SYSFS TO CONTROL HARDWARE THAT HAS PROPER KERNEL DRIVERS.
-PLEASE READ THE DOCUMENT AT Documentation/driver-api/gpio/drivers-on-gpio.rst
+PLEASE READ Documentation/driver-api/gpio/drivers-on-gpio.rst
 TO AVOID REINVENTING KERNEL WHEELS IN USERSPACE. I MEAN IT. REALLY.
 
 Paths in Sysfs
-- 
2.39.2