linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Kent Gibson <warthog618@gmail.com>
To: linux-kernel@vger.kernel.org, linux-gpio@vger.kernel.org,
	linux-doc@vger.kernel.org, brgl@bgdev.pl,
	linus.walleij@linaro.org, andy@kernel.org, corbet@lwn.net
Cc: Kent Gibson <warthog618@gmail.com>
Subject: [PATCH 3/7] Documentation: gpio: update sysfs documentation to reference new chardev doc
Date: Tue,  9 Jan 2024 21:59:48 +0800	[thread overview]
Message-ID: <20240109135952.77458-4-warthog618@gmail.com> (raw)
In-Reply-To: <20240109135952.77458-1-warthog618@gmail.com>

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

Signed-off-by: Kent Gibson <warthog618@gmail.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


  parent reply	other threads:[~2024-01-09 14:00 UTC|newest]

Thread overview: 23+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-01-09 13:59 [PATCH 0/7] Documentation: gpio: add character device userspace API documentation Kent Gibson
2024-01-09 13:59 ` [PATCH 1/7] Documentation: gpio: add chardev " Kent Gibson
2024-01-10 11:40   ` Phil Howard
2024-01-10 12:20     ` Andy Shevchenko
2024-01-10 13:01     ` Kent Gibson
2024-01-10 14:27       ` Linus Walleij
2024-01-10 14:34         ` Kent Gibson
2024-01-10 14:50           ` Linus Walleij
2024-01-10 14:53             ` Kent Gibson
2024-01-09 13:59 ` [PATCH 2/7] Documentation: gpio: move sysfs into a deprecated section Kent Gibson
2024-01-09 13:59 ` Kent Gibson [this message]
2024-01-09 13:59 ` [PATCH 4/7] Documentation: gpio: add chardev v1 userspace API documentation Kent Gibson
2024-01-09 13:59 ` [PATCH 5/7] Documentation: gpio: capitalize GPIO in index title Kent Gibson
2024-01-09 13:59 ` [PATCH 6/7] Documentation: gpio: document gpio-mockup as obsoleted by gpio-sim Kent Gibson
2024-01-09 13:59 ` [PATCH 7/7] Documentation: gpio: move gpio-mockup into deprecated section Kent Gibson
2024-01-09 20:00 ` [PATCH 0/7] Documentation: gpio: add character device userspace API documentation Andy Shevchenko
2024-01-09 23:45   ` Kent Gibson
2024-01-10  8:16     ` Vegard Nossum
2024-01-10 11:10       ` Andy Shevchenko
2024-01-12  1:03         ` Kent Gibson
2024-01-14  2:47 ` Kent Gibson
2024-01-14 12:01   ` Andy Shevchenko
2024-01-14 12:55     ` Kent Gibson

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20240109135952.77458-4-warthog618@gmail.com \
    --to=warthog618@gmail.com \
    --cc=andy@kernel.org \
    --cc=brgl@bgdev.pl \
    --cc=corbet@lwn.net \
    --cc=linus.walleij@linaro.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-gpio@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
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).