From: Ard Biesheuvel <ardb@kernel.org>
To: Randy Dunlap <rdunlap@infradead.org>
Cc: linux-kernel@vger.kernel.org, linux-efi@vger.kernel.org
Subject: Re: [PATCH] efi: memmap: fix kernel-doc warnings
Date: Fri, 22 Dec 2023 10:42:30 +0100 [thread overview]
Message-ID: <CAMj1kXH_zVrMEUQFFPsJ-0ugbptUWa-t02W7w8+zQrCgxMJU0A@mail.gmail.com> (raw)
In-Reply-To: <20231222061923.10170-1-rdunlap@infradead.org>
On Fri, 22 Dec 2023 at 07:19, Randy Dunlap <rdunlap@infradead.org> wrote:
>
> Correct all kernel-doc notation to repair warnings that are
> reported by scripts/kernel-doc:
>
> memmap.c:38: warning: No description found for return value of '__efi_memmap_init'
> memmap.c:82: warning: No description found for return value of 'efi_memmap_init_early'
> memmap.c:132: warning: Function parameter or member 'addr' not described in 'efi_memmap_init_late'
> memmap.c:132: warning: Excess function parameter 'phys_addr' description in 'efi_memmap_init_late'
> memmap.c:132: warning: No description found for return value of 'efi_memmap_init_late'
>
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc: Ard Biesheuvel <ardb@kernel.org>
> Cc: linux-efi@vger.kernel.org
Thanks, queued in efi/next.
> ---
> drivers/firmware/efi/memmap.c | 8 +++++---
> 1 file changed, 5 insertions(+), 3 deletions(-)
>
> diff -- a/drivers/firmware/efi/memmap.c b/drivers/firmware/efi/memmap.c
> --- a/drivers/firmware/efi/memmap.c
> +++ b/drivers/firmware/efi/memmap.c
> @@ -32,7 +32,7 @@
> * space isn't setup. Once the kernel is fully booted we can fallback
> * to the more robust memremap*() API.
> *
> - * Returns zero on success, a negative error code on failure.
> + * Returns: zero on success, a negative error code on failure.
> */
> int __init __efi_memmap_init(struct efi_memory_map_data *data)
> {
> @@ -77,6 +77,8 @@ int __init __efi_memmap_init(struct efi_
> *
> * Use early_memremap() to map the passed in EFI memory map and assign
> * it to efi.memmap.
> + *
> + * Returns: zero on success, a negative error code on failure.
> */
> int __init efi_memmap_init_early(struct efi_memory_map_data *data)
> {
> @@ -107,7 +109,7 @@ void __init efi_memmap_unmap(void)
>
> /**
> * efi_memmap_init_late - Map efi.memmap with memremap()
> - * @phys_addr: Physical address of the new EFI memory map
> + * @addr: Physical address of the new EFI memory map
> * @size: Size in bytes of the new EFI memory map
> *
> * Setup a mapping of the EFI memory map using ioremap_cache(). This
> @@ -126,7 +128,7 @@ void __init efi_memmap_unmap(void)
> * runtime so that things like efi_mem_desc_lookup() and
> * efi_mem_attributes() always work.
> *
> - * Returns zero on success, a negative error code on failure.
> + * Returns: zero on success, a negative error code on failure.
> */
> int __init efi_memmap_init_late(phys_addr_t addr, unsigned long size)
> {
prev parent reply other threads:[~2023-12-22 9:42 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-12-22 6:19 [PATCH] efi: memmap: fix kernel-doc warnings Randy Dunlap
2023-12-22 9:42 ` Ard Biesheuvel [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=CAMj1kXH_zVrMEUQFFPsJ-0ugbptUWa-t02W7w8+zQrCgxMJU0A@mail.gmail.com \
--to=ardb@kernel.org \
--cc=linux-efi@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=rdunlap@infradead.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
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 read-only IMAP folder(s) and NNTP newsgroup(s).