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 2/7] Documentation: gpio: move sysfs into a deprecated section
Date: Tue, 9 Jan 2024 21:59:47 +0800 [thread overview]
Message-ID: <20240109135952.77458-3-warthog618@gmail.com> (raw)
In-Reply-To: <20240109135952.77458-1-warthog618@gmail.com>
The GPIO sysfs API is long deprecated, so highlight this even further
by moving it into a deprecated APIs section in both the admin-guide
and userspace-api books.
Signed-off-by: Kent Gibson <warthog618@gmail.com>
---
Documentation/admin-guide/gpio/deprecated.rst | 11 +++++++++++
Documentation/admin-guide/gpio/index.rst | 2 +-
Documentation/userspace-api/gpio/deprecated.rst | 10 ++++++++++
Documentation/userspace-api/gpio/index.rst | 1 +
.../{admin-guide => userspace-api}/gpio/sysfs.rst | 0
5 files changed, 23 insertions(+), 1 deletion(-)
create mode 100644 Documentation/admin-guide/gpio/deprecated.rst
create mode 100644 Documentation/userspace-api/gpio/deprecated.rst
rename Documentation/{admin-guide => userspace-api}/gpio/sysfs.rst (100%)
diff --git a/Documentation/admin-guide/gpio/deprecated.rst b/Documentation/admin-guide/gpio/deprecated.rst
new file mode 100644
index 000000000000..33f701294732
--- /dev/null
+++ b/Documentation/admin-guide/gpio/deprecated.rst
@@ -0,0 +1,11 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+====================
+Deprecated GPIO APIs
+====================
+
+.. toctree::
+ :maxdepth: 1
+
+ Sysfs Interface <../../userspace-api/gpio/sysfs>
+
diff --git a/Documentation/admin-guide/gpio/index.rst b/Documentation/admin-guide/gpio/index.rst
index b40f0a2a6822..9b0630f30d3e 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
+ Deprecated APIs <deprecated>
.. only:: subproject and html
diff --git a/Documentation/userspace-api/gpio/deprecated.rst b/Documentation/userspace-api/gpio/deprecated.rst
new file mode 100644
index 000000000000..4cc7c79d7c23
--- /dev/null
+++ b/Documentation/userspace-api/gpio/deprecated.rst
@@ -0,0 +1,10 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+==============================
+Deprecated GPIO Userspace APIs
+==============================
+
+.. toctree::
+ :maxdepth: 1
+
+ Sysfs Interface <sysfs>
diff --git a/Documentation/userspace-api/gpio/index.rst b/Documentation/userspace-api/gpio/index.rst
index 072b9fa18aea..17f0f92db384 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>
+ Deprecated Userspace APIs <deprecated>
.. only:: subproject and html
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-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 ` Kent Gibson [this message]
2024-01-09 13:59 ` [PATCH 3/7] Documentation: gpio: update sysfs documentation to reference new chardev doc Kent Gibson
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-3-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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.