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 2/2] docs: nvmem: remove function parameters (fixes hyperlink generation)
Date: Fri, 01 Dec 2023 14:10:43 +0100 [thread overview]
Message-ID: <20231201-nvmem-docs-kerneldoc-v1-2-3e8f2b706ce6@bootlin.com> (raw)
In-Reply-To: <20231201-nvmem-docs-kerneldoc-v1-0-3e8f2b706ce6@bootlin.com>
Adding a parameter is not particularly useful here, and it is definitely
not done elsewhere. It also prevents the generation of a hyperlink to the
kernel-doc documentation. Removing the parameter to enable hyperlinks and
make the style coherent.
Signed-off-by: Luca Ceresoli <luca.ceresoli@bootlin.com>
---
Documentation/driver-api/nvmem.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/Documentation/driver-api/nvmem.rst b/Documentation/driver-api/nvmem.rst
index d5655b95c0f4..5d9500d21ecc 100644
--- a/Documentation/driver-api/nvmem.rst
+++ b/Documentation/driver-api/nvmem.rst
@@ -41,7 +41,7 @@ A NVMEM provider can register with NVMEM core by supplying relevant
nvmem configuration to nvmem_register(), on success core would return a valid
nvmem_device pointer.
-nvmem_unregister(nvmem) is used to unregister a previously registered provider.
+nvmem_unregister() is used to unregister a previously registered provider.
For example, a simple nvram case::
--
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 ` [PATCH 1/2] docs: nvmem: generate kernel-doc API documentation Luca Ceresoli
2023-12-03 6:04 ` Bagas Sanjaya
2023-12-01 13:10 ` Luca Ceresoli [this message]
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-2-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).