linux-kernel - [PATCH] docs: driver-model: generate kernel-doc for driver model using script

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 for Android: free password hash cracker in your pocket

[<prev] [next>] [day] [month] [year] [list]

Message-Id: <20241107033303.97509-1-yesanishhere@gmail.com>
Date: Wed,  6 Nov 2024 19:33:03 -0800
From: anish kumar <yesanishhere@...il.com>
To: corbet@....net,
	broonie@...nel.org,
	dlechner@...libre.com,
	u.kleine-koenig@...gutronix.de,
	Jonathan.Cameron@...wei.com,
	pstanner@...hat.com
Cc: linux-kernel@...r.kernel.org,
	linux-doc@...r.kernel.org,
	anish kumar <yesanishhere@...il.com>
Subject: [PATCH] docs: driver-model: generate kernel-doc for driver model using script

In commit 63dc355 ("remove the driver-model structures from the
documentation"), the kernel-doc text was removed, and users were
instructed to read the documentation directly from the source code.
However, using the kernel-doc script to extract and generate the
documentation is a better approach, as it ensures the documentation
remains in sync with the code. Additionally, it provides users with
a more convenient way to access the documentation without needing to
refer directly to the source code.

This patch adds kernel-doc annotations for the driver model to
facilitate the use of the kernel-doc script.

Signed-off-by: anish kumar <yesanishhere@...il.com>
---
 Documentation/driver-api/driver-model/bus.rst    | 4 +++-
 Documentation/driver-api/driver-model/device.rst | 4 ++--
 Documentation/driver-api/driver-model/driver.rst | 3 ++-
 3 files changed, 7 insertions(+), 4 deletions(-)

diff --git a/Documentation/driver-api/driver-model/bus.rst b/Documentation/driver-api/driver-model/bus.rst
index 9709ab62a468..15fb77fc69df 100644
--- a/Documentation/driver-api/driver-model/bus.rst
+++ b/Documentation/driver-api/driver-model/bus.rst
@@ -4,7 +4,9 @@ Bus Types
 
 Definition
 ~~~~~~~~~~
-See the kerneldoc for the struct bus_type.
+
+.. kernel-doc:: include/linux/device/bus.h
+    :identifiers: struct bus_type
 
 int bus_register(struct bus_type * bus);
 
diff --git a/Documentation/driver-api/driver-model/device.rst b/Documentation/driver-api/driver-model/device.rst
index 0833be568b06..14095770e80b 100644
--- a/Documentation/driver-api/driver-model/device.rst
+++ b/Documentation/driver-api/driver-model/device.rst
@@ -2,8 +2,8 @@
 The Basic Device Structure
 ==========================
 
-See the kerneldoc for the struct device.
-
+.. kernel-doc:: include/linux/device/device.h
+    :identifiers: struct device
 
 Programming Interface
 ~~~~~~~~~~~~~~~~~~~~~
diff --git a/Documentation/driver-api/driver-model/driver.rst b/Documentation/driver-api/driver-model/driver.rst
index 06f818b1d622..b5e8b00878ca 100644
--- a/Documentation/driver-api/driver-model/driver.rst
+++ b/Documentation/driver-api/driver-model/driver.rst
@@ -2,7 +2,8 @@
 Device Drivers
 ==============
 
-See the kerneldoc for the struct device_driver.
+.. kernel-doc:: include/linux/device/driver.h
+    :identifiers: struct device_driver
 
 Allocation
 ~~~~~~~~~~
-- 
2.39.3 (Apple Git-146)