From: Luca Ceresoli <luca.ceresoli@bootlin.com>
To: Jonathan Corbet <corbet@lwn.net>
Cc: Thomas Petazzoni <thomas.petazzoni@bootlin.com>,
linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
Luca Ceresoli <luca.ceresoli@bootlin.com>
Subject: [PATCH 1/2] docs: nvmem: generate kernel-doc API documentation
Date: Fri, 01 Dec 2023 14:10:42 +0100 [thread overview]
Message-ID: <20231201-nvmem-docs-kerneldoc-v1-1-3e8f2b706ce6@bootlin.com> (raw)
In-Reply-To: <20231201-nvmem-docs-kerneldoc-v1-0-3e8f2b706ce6@bootlin.com>
This is useful on its own, and it also enables hyperlink generation for
functions mentioned in ReST documentation.
Signed-off-by: Luca Ceresoli <luca.ceresoli@bootlin.com>
---
Documentation/driver-api/nvmem.rst | 6 ++++++
1 file changed, 6 insertions(+)
diff --git a/Documentation/driver-api/nvmem.rst b/Documentation/driver-api/nvmem.rst
index de221e91c8e3..d5655b95c0f4 100644
--- a/Documentation/driver-api/nvmem.rst
+++ b/Documentation/driver-api/nvmem.rst
@@ -200,3 +200,9 @@ and let you add cells dynamically.
Another use case for layouts is the post processing of cells. With layouts,
it is possible to associate a custom post processing hook to a cell. It
even possible to add this hook to cells not created by the layout itself.
+
+9. Internal kernel API
+======================
+
+.. kernel-doc:: drivers/nvmem/core.c
+ :export:
--
2.34.1
next prev parent reply other threads:[~2023-12-01 13:10 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-12-01 13:10 [PATCH 0/2] docs: nvmem: minor improvements Luca Ceresoli
2023-12-01 13:10 ` Luca Ceresoli [this message]
2023-12-03 6:04 ` [PATCH 1/2] docs: nvmem: generate kernel-doc API documentation Bagas Sanjaya
2023-12-01 13:10 ` [PATCH 2/2] docs: nvmem: remove function parameters (fixes hyperlink generation) Luca Ceresoli
2023-12-08 22:44 ` [PATCH 0/2] docs: nvmem: minor improvements Jonathan Corbet
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=20231201-nvmem-docs-kerneldoc-v1-1-3e8f2b706ce6@bootlin.com \
--to=luca.ceresoli@bootlin.com \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=thomas.petazzoni@bootlin.com \
/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;
as well as URLs for NNTP newsgroup(s).