Received-SPF: pass (google.com: domain of linux-kernel+bounces-9555-linux.lists.archive=gmail.com@vger.kernel.org designates 147.75.199.223 as permitted sender) client-ip=147.75.199.223;
Precedence: bulk
MIME-Version: 1.0
References: <20231222061923.10170-1-rdunlap@infradead.org>
In-Reply-To: <20231222061923.10170-1-rdunlap@infradead.org>
From: Ard Biesheuvel <ardb@kernel.org>
Date: Fri, 22 Dec 2023 10:42:30 +0100
Message-ID: <CAMj1kXH_zVrMEUQFFPsJ-0ugbptUWa-t02W7w8+zQrCgxMJU0A@mail.gmail.com>
Subject: Re: [PATCH] efi: memmap: fix kernel-doc warnings
To: Randy Dunlap <rdunlap@infradead.org>
Cc: linux-kernel@vger.kernel.org, linux-efi@vger.kernel.org
Content-Type: text/plain; charset="UTF-8"

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