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 v2 4/9] Documentation: gpio: move sysfs into an obsolete section
Date: Mon, 15 Jan 2024 08:48:42 +0800 [thread overview]
Message-ID: <20240115004847.22369-5-warthog618@gmail.com> (raw)
In-Reply-To: <20240115004847.22369-1-warthog618@gmail.com>
The GPIO sysfs API is long obsolete, so highlight this even further
by moving it into an obsolete APIs section in both the admin-guide
and userspace-api books.
Signed-off-by: Kent Gibson <warthog618@gmail.com>
---
Documentation/admin-guide/gpio/index.rst | 2 +-
Documentation/admin-guide/gpio/obsolete.rst | 11 +++++++++++
Documentation/userspace-api/gpio/index.rst | 1 +
Documentation/userspace-api/gpio/obsolete.rst | 10 ++++++++++
.../{admin-guide => userspace-api}/gpio/sysfs.rst | 0
5 files changed, 23 insertions(+), 1 deletion(-)
create mode 100644 Documentation/admin-guide/gpio/obsolete.rst
create mode 100644 Documentation/userspace-api/gpio/obsolete.rst
rename Documentation/{admin-guide => userspace-api}/gpio/sysfs.rst (100%)
diff --git a/Documentation/admin-guide/gpio/index.rst b/Documentation/admin-guide/gpio/index.rst
index b40f0a2a6822..3ac3aa15fa8b 100644
--- a/Documentation/admin-guide/gpio/index.rst
+++ b/Documentation/admin-guide/gpio/index.rst
@@ -9,9 +9,9 @@ gpio
Character Device Userspace API <../../userspace-api/gpio/chardev>
gpio-aggregator
- sysfs
gpio-mockup
gpio-sim
+ Obsolete APIs <obsolete>
.. only:: subproject and html
diff --git a/Documentation/admin-guide/gpio/obsolete.rst b/Documentation/admin-guide/gpio/obsolete.rst
new file mode 100644
index 000000000000..dbf88f13c680
--- /dev/null
+++ b/Documentation/admin-guide/gpio/obsolete.rst
@@ -0,0 +1,11 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+==================
+Obsolete GPIO APIs
+==================
+
+.. toctree::
+ :maxdepth: 1
+
+ Sysfs Interface <../../userspace-api/gpio/sysfs>
+
diff --git a/Documentation/userspace-api/gpio/index.rst b/Documentation/userspace-api/gpio/index.rst
index 072b9fa18aea..f258de4ef370 100644
--- a/Documentation/userspace-api/gpio/index.rst
+++ b/Documentation/userspace-api/gpio/index.rst
@@ -8,6 +8,7 @@ GPIO
:maxdepth: 1
Character Device Userspace API <chardev>
+ Obsolete Userspace APIs <obsolete>
.. only:: subproject and html
diff --git a/Documentation/userspace-api/gpio/obsolete.rst b/Documentation/userspace-api/gpio/obsolete.rst
new file mode 100644
index 000000000000..c27bd6014a3d
--- /dev/null
+++ b/Documentation/userspace-api/gpio/obsolete.rst
@@ -0,0 +1,10 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+============================
+Obsolete GPIO Userspace APIs
+============================
+
+.. toctree::
+ :maxdepth: 1
+
+ Sysfs Interface <sysfs>
diff --git a/Documentation/admin-guide/gpio/sysfs.rst b/Documentation/userspace-api/gpio/sysfs.rst
similarity index 100%
rename from Documentation/admin-guide/gpio/sysfs.rst
rename to Documentation/userspace-api/gpio/sysfs.rst
--
2.39.2
next prev parent reply other threads:[~2024-01-15 0:49 UTC|newest]
Thread overview: 15+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-01-15 0:48 [PATCH v2 0/9] Documentation: gpio: add character device userspace API documentation Kent Gibson
2024-01-15 0:48 ` [PATCH v2 1/9] Documentation: gpio: add chardev " Kent Gibson
2024-01-15 1:11 ` Andy Shevchenko
2024-01-15 1:30 ` Kent Gibson
2024-01-15 0:48 ` [PATCH v2 2/9] Documentation: ABI: update gpio-cdev to reference chardev.rst Kent Gibson
2024-01-15 0:48 ` [PATCH v2 3/9] Documentation: ABI: update sysfs-gpio to reference gpio-cdev Kent Gibson
2024-01-15 0:48 ` Kent Gibson [this message]
2024-01-15 0:48 ` [PATCH v2 5/9] Documentation: gpio: update sysfs documentation to reference new chardev doc Kent Gibson
2024-01-15 0:48 ` [PATCH v2 6/9] Documentation: gpio: add chardev v1 userspace API documentation Kent Gibson
2024-01-15 0:48 ` [PATCH v2 7/9] Documentation: gpio: capitalize GPIO in index title Kent Gibson
2024-01-15 0:48 ` [PATCH v2 8/9] Documentation: gpio: document gpio-mockup as obsoleted by gpio-sim Kent Gibson
2024-01-15 0:48 ` [PATCH v2 9/9] Documentation: gpio: move gpio-mockup into obsolete section Kent Gibson
2024-01-15 1:20 ` Andy Shevchenko
2024-01-15 1:36 ` Kent Gibson
2024-01-22 9:50 ` [PATCH v2 0/9] Documentation: gpio: add character device userspace API documentation Bartosz Golaszewski
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=20240115004847.22369-5-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).