From: anish kumar <yesanishhere@gmail.com>
To: corbet@lwn.net, broonie@kernel.org, dlechner@baylibre.com,
u.kleine-koenig@pengutronix.de, Jonathan.Cameron@huawei.com,
pstanner@redhat.com
Cc: linux-kernel@vger.kernel.org, linux-doc@vger.kernel.org,
anish kumar <yesanishhere@gmail.com>
Subject: [PATCH] docs: driver-model: generate kernel-doc for driver model using script
Date: Wed, 6 Nov 2024 19:33:03 -0800 [thread overview]
Message-ID: <20241107033303.97509-1-yesanishhere@gmail.com> (raw)
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@gmail.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)
next reply other threads:[~2024-11-07 3:33 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-11-07 3:33 anish kumar [this message]
2024-11-12 20:18 ` Jonathan Corbet
2024-11-12 21:41 ` anish kumar
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=20241107033303.97509-1-yesanishhere@gmail.com \
--to=yesanishhere@gmail.com \
--cc=Jonathan.Cameron@huawei.com \
--cc=broonie@kernel.org \
--cc=corbet@lwn.net \
--cc=dlechner@baylibre.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=pstanner@redhat.com \
--cc=u.kleine-koenig@pengutronix.de \
/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
all inboxes | Powered by JetHome®