linux-kernel - [PATCH 2/2] docs: nvmem: remove function parameters (fixes hyperlink generation)

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: <20231201-nvmem-docs-kerneldoc-v1-2-3e8f2b706ce6@bootlin.com>
Date:   Fri, 01 Dec 2023 14:10:43 +0100
From:   Luca Ceresoli <luca.ceresoli@...tlin.com>
To:     Jonathan Corbet <corbet@....net>
Cc:     Thomas Petazzoni <thomas.petazzoni@...tlin.com>,
        linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org,
        Luca Ceresoli <luca.ceresoli@...tlin.com>
Subject: [PATCH 2/2] docs: nvmem: remove function parameters (fixes
 hyperlink generation)

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