linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH 1/1] efi/libstub: add libstub/mem.c to documentation tree
@ 2020-02-21  3:58 Heinrich Schuchardt
  2020-02-21  7:21 ` Ard Biesheuvel
  2020-02-25 10:25 ` Jonathan Corbet
  0 siblings, 2 replies; 6+ messages in thread
From: Heinrich Schuchardt @ 2020-02-21  3:58 UTC (permalink / raw)
  To: Jonathan Corbet
  Cc: Ard Biesheuvel, linux-doc, linux-kernel, Heinrich Schuchardt

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


^ permalink raw reply related	[flat|nested] 6+ messages in thread

* Re: [PATCH 1/1] efi/libstub: add libstub/mem.c to documentation tree
  2020-02-21  3:58 [PATCH 1/1] efi/libstub: add libstub/mem.c to documentation tree Heinrich Schuchardt
@ 2020-02-21  7:21 ` Ard Biesheuvel
  2020-02-25 10:25 ` Jonathan Corbet
  1 sibling, 0 replies; 6+ messages in thread
From: Ard Biesheuvel @ 2020-02-21  7:21 UTC (permalink / raw)
  To: Heinrich Schuchardt
  Cc: Jonathan Corbet, Linux Doc Mailing List, Linux Kernel Mailing List

On Fri, 21 Feb 2020 at 04:58, Heinrich Schuchardt <xypron.glpk@gmx.de> 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 <xypron.glpk@gmx.de>

Acked-by: Ard Biesheuvel <ardb@kernel.org>

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

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: [PATCH 1/1] efi/libstub: add libstub/mem.c to documentation tree
  2020-02-21  3:58 [PATCH 1/1] efi/libstub: add libstub/mem.c to documentation tree Heinrich Schuchardt
  2020-02-21  7:21 ` Ard Biesheuvel
@ 2020-02-25 10:25 ` Jonathan Corbet
  2020-02-25 10:26   ` Ard Biesheuvel
  1 sibling, 1 reply; 6+ messages in thread
From: Jonathan Corbet @ 2020-02-25 10:25 UTC (permalink / raw)
  To: Heinrich Schuchardt; +Cc: Ard Biesheuvel, linux-doc, linux-kernel

On Fri, 21 Feb 2020 04:58:32 +0100
Heinrich Schuchardt <xypron.glpk@gmx.de> 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 <xypron.glpk@gmx.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

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

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: [PATCH 1/1] efi/libstub: add libstub/mem.c to documentation tree
  2020-02-25 10:25 ` Jonathan Corbet
@ 2020-02-25 10:26   ` Ard Biesheuvel
  2020-02-25 10:38     ` Jonathan Corbet
  0 siblings, 1 reply; 6+ messages in thread
From: Ard Biesheuvel @ 2020-02-25 10:26 UTC (permalink / raw)
  To: Jonathan Corbet
  Cc: Heinrich Schuchardt, Linux Doc Mailing List, Linux Kernel Mailing List

On Tue, 25 Feb 2020 at 11:25, Jonathan Corbet <corbet@lwn.net> wrote:
>
> On Fri, 21 Feb 2020 04:58:32 +0100
> Heinrich Schuchardt <xypron.glpk@gmx.de> 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 <xypron.glpk@gmx.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
>
> 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?

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: [PATCH 1/1] efi/libstub: add libstub/mem.c to documentation tree
  2020-02-25 10:26   ` Ard Biesheuvel
@ 2020-02-25 10:38     ` Jonathan Corbet
  2020-02-25 10:38       ` Ard Biesheuvel
  0 siblings, 1 reply; 6+ messages in thread
From: Jonathan Corbet @ 2020-02-25 10:38 UTC (permalink / raw)
  To: Ard Biesheuvel
  Cc: Heinrich Schuchardt, Linux Doc Mailing List, Linux Kernel Mailing List

On Tue, 25 Feb 2020 11:26:01 +0100
Ard Biesheuvel <ardb@kernel.org> 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 <corbet@lwn.net>

jon

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: [PATCH 1/1] efi/libstub: add libstub/mem.c to documentation tree
  2020-02-25 10:38     ` Jonathan Corbet
@ 2020-02-25 10:38       ` Ard Biesheuvel
  0 siblings, 0 replies; 6+ messages in thread
From: Ard Biesheuvel @ 2020-02-25 10:38 UTC (permalink / raw)
  To: Jonathan Corbet
  Cc: Heinrich Schuchardt, Linux Doc Mailing List, Linux Kernel Mailing List

On Tue, 25 Feb 2020 at 11:38, Jonathan Corbet <corbet@lwn.net> wrote:
>
> On Tue, 25 Feb 2020 11:26:01 +0100
> Ard Biesheuvel <ardb@kernel.org> 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 <corbet@lwn.net>
>

Thanks Jon

^ permalink raw reply	[flat|nested] 6+ messages in thread

end of thread, other threads:[~2020-02-25 10:38 UTC | newest]

Thread overview: 6+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-02-21  3:58 [PATCH 1/1] efi/libstub: add libstub/mem.c to documentation tree Heinrich Schuchardt
2020-02-21  7:21 ` Ard Biesheuvel
2020-02-25 10:25 ` Jonathan Corbet
2020-02-25 10:26   ` Ard Biesheuvel
2020-02-25 10:38     ` Jonathan Corbet
2020-02-25 10:38       ` Ard Biesheuvel

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).