linux-kernel - [PATCH 1/2] docs: nvmem: generate kernel-doc API documentation

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-1-3e8f2b706ce6@bootlin.com>
Date:   Fri, 01 Dec 2023 14:10:42 +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 1/2] docs: nvmem: generate kernel-doc API documentation

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