linux-kernel - [PATCH 1/1] efi/libstub: add libstub/mem.c to documentation tree

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-next>] [day] [month] [year] [list]

Message-Id: <20200221035832.144960-1-xypron.glpk@gmx.de>
Date:   Fri, 21 Feb 2020 04:58:32 +0100
From:   Heinrich Schuchardt <xypron.glpk@....de>
To:     Jonathan Corbet <corbet@....net>
Cc:     Ard Biesheuvel <ardb@...nel.org>, linux-doc@...r.kernel.org,
        linux-kernel@...r.kernel.org,
        Heinrich Schuchardt <xypron.glpk@....de>
Subject: [PATCH 1/1] efi/libstub: add libstub/mem.c to documentation tree

Let the description of the efi/libstub/mem.c functions appear in the Kernel
API documentation in chapter

    The Linux driver implementer’s API guide
        Linux Firmware API
            UEFI Support
                UEFI stub library functions

Signed-off-by: Heinrich Schuchardt <xypron.glpk@....de>
---
The corresponding source patches are still in efi/next.

https://lkml.org/lkml/2020/2/20/115
https://lkml.org/lkml/2020/2/18/37
https://lkml.org/lkml/2020/2/16/154
---
 Documentation/driver-api/firmware/efi/index.rst | 11 +++++++++++
 Documentation/driver-api/firmware/index.rst     |  1 +
 2 files changed, 12 insertions(+)
 create mode 100644 Documentation/driver-api/firmware/efi/index.rst

diff --git a/Documentation/driver-api/firmware/efi/index.rst b/Documentation/driver-api/firmware/efi/index.rst
new file mode 100644
index 000000000000..4fe8abba9fc6
--- /dev/null
+++ b/Documentation/driver-api/firmware/efi/index.rst
@@ -0,0 +1,11 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+============
+UEFI Support
+============
+
+UEFI stub library functions
+===========================
+
+.. kernel-doc:: drivers/firmware/efi/libstub/mem.c
+   :internal:
diff --git a/Documentation/driver-api/firmware/index.rst b/Documentation/driver-api/firmware/index.rst
index 29da39ec4b8a..57415d657173 100644
--- a/Documentation/driver-api/firmware/index.rst
+++ b/Documentation/driver-api/firmware/index.rst
@@ -6,6 +6,7 @@ Linux Firmware API

    introduction
    core
+   efi/index
    request_firmware
    other_interfaces

--
2.25.0