[PATCH v2 4/9] Documentation: gpio: move sysfs into an obsolete section

From: Kent Gibson
Date: Sun Jan 14 2024 - 19:50:37 EST


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@xxxxxxxxx>
---
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