2020-02-21 03:59:07

by Heinrich Schuchardt

[permalink] [raw]
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 <[email protected]>
---
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


2020-02-21 07:21:56

by Ard Biesheuvel

[permalink] [raw]
Subject: Re: [PATCH 1/1] efi/libstub: add libstub/mem.c to documentation tree

On Fri, 21 Feb 2020 at 04:58, Heinrich Schuchardt <[email protected]> wrote:
>
> 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 <[email protected]>

Acked-by: Ard Biesheuvel <[email protected]>

> ---
> 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
>

2020-02-25 10:26:51

by Jonathan Corbet

[permalink] [raw]
Subject: Re: [PATCH 1/1] efi/libstub: add libstub/mem.c to documentation tree

On Fri, 21 Feb 2020 04:58:32 +0100
Heinrich Schuchardt <[email protected]> wrote:

> 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 <[email protected]>
> ---
> 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

Given that this patch depends on work in the efi tree, I'm assuming that
the docs changes will go in via that path as well.

Thanks,

jon

2020-02-25 10:27:02

by Ard Biesheuvel

[permalink] [raw]
Subject: Re: [PATCH 1/1] efi/libstub: add libstub/mem.c to documentation tree

On Tue, 25 Feb 2020 at 11:25, Jonathan Corbet <[email protected]> wrote:
>
> On Fri, 21 Feb 2020 04:58:32 +0100
> Heinrich Schuchardt <[email protected]> wrote:
>
> > 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 <[email protected]>
> > ---
> > 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
>
> Given that this patch depends on work in the efi tree, I'm assuming that
> the docs changes will go in via that path as well.
>

Can I take that as an acked-by?

2020-02-25 10:39:44

by Jonathan Corbet

[permalink] [raw]
Subject: Re: [PATCH 1/1] efi/libstub: add libstub/mem.c to documentation tree

On Tue, 25 Feb 2020 11:26:01 +0100
Ard Biesheuvel <[email protected]> wrote:

> > Given that this patch depends on work in the efi tree, I'm assuming that
> > the docs changes will go in via that path as well.
> >
>
> Can I take that as an acked-by?
>
Yes, of course:

Acked-by: Jonathan Corbet <[email protected]>

jon

2020-02-25 10:39:53

by Ard Biesheuvel

[permalink] [raw]
Subject: Re: [PATCH 1/1] efi/libstub: add libstub/mem.c to documentation tree

On Tue, 25 Feb 2020 at 11:38, Jonathan Corbet <[email protected]> wrote:
>
> On Tue, 25 Feb 2020 11:26:01 +0100
> Ard Biesheuvel <[email protected]> wrote:
>
> > > Given that this patch depends on work in the efi tree, I'm assuming that
> > > the docs changes will go in via that path as well.
> > >
> >
> > Can I take that as an acked-by?
> >
> Yes, of course:
>
> Acked-by: Jonathan Corbet <[email protected]>
>

Thanks Jon