diff mbox series

[1/2] doc/efi: add firmware management protocol to the documentation

Message ID 20220525092022.834964-1-vincent.stehle@arm.com
State Accepted, archived
Commit 2ee9550a7d230c6711d2f263c75c7f3262ff7958
Delegated to: Heinrich Schuchardt
Headers show
Series [1/2] doc/efi: add firmware management protocol to the documentation | expand

Commit Message

Vincent Stehlé May 25, 2022, 9:20 a.m. UTC
The firmware management protocol can be used to manage device firmware.
U-Boot can be configured to provide an implementation.

Document the related functions in the API section.

Signed-off-by: Vincent Stehlé <vincent.stehle@arm.com>
Cc: Heinrich Schuchardt <xypron.glpk@gmx.de>
---
 doc/api/efi.rst | 6 ++++++
 1 file changed, 6 insertions(+)

Comments

Heinrich Schuchardt May 25, 2022, 10:12 a.m. UTC | #1
On 5/25/22 11:20, Vincent Stehlé wrote:
> The firmware management protocol can be used to manage device firmware.
> U-Boot can be configured to provide an implementation.
>
> Document the related functions in the API section.
>
> Signed-off-by: Vincent Stehlé <vincent.stehle@arm.com>
> Cc: Heinrich Schuchardt <xypron.glpk@gmx.de>

When merging this patch should succeed 2/2 to avoid build failures.

Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de>

> ---
>   doc/api/efi.rst | 6 ++++++
>   1 file changed, 6 insertions(+)
>
> diff --git a/doc/api/efi.rst b/doc/api/efi.rst
> index cb2a1c897e6..2b96783828b 100644
> --- a/doc/api/efi.rst
> +++ b/doc/api/efi.rst
> @@ -166,6 +166,12 @@ Unicode Collation protocol
>   .. kernel-doc:: lib/efi_loader/efi_unicode_collation.c
>      :internal:
>
> +Firmware management protocol
> +~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> +
> +.. kernel-doc:: lib/efi_loader/efi_firmware.c
> +   :internal:
> +
>   Unit testing
>   ------------
>
diff mbox series

Patch

diff --git a/doc/api/efi.rst b/doc/api/efi.rst
index cb2a1c897e6..2b96783828b 100644
--- a/doc/api/efi.rst
+++ b/doc/api/efi.rst
@@ -166,6 +166,12 @@  Unicode Collation protocol
 .. kernel-doc:: lib/efi_loader/efi_unicode_collation.c
    :internal:
 
+Firmware management protocol
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. kernel-doc:: lib/efi_loader/efi_firmware.c
+   :internal:
+
 Unit testing
 ------------