linux-kernel - [PATCH 2/7] Documentation: gpio: move sysfs into a deprecated section

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]

Message-Id: <20240109135952.77458-3-warthog618@gmail.com>
Date: Tue,  9 Jan 2024 21:59:47 +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 2/7] Documentation: gpio: move sysfs into a deprecated section

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@...il.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