Re: [PATCH] acpi/osl: fix a W=1 kernel-doc warning

From: Rafael J. Wysocki
Date: Thu Jun 13 2019 - 16:33:53 EST


On Monday, June 3, 2019 10:28:35 PM CEST Qian Cai wrote:
> It appears that kernel-doc does not understand the return type *__ref,
>
> drivers/acpi/osl.c:306: warning: cannot understand function prototype:
> 'void __iomem *__ref acpi_os_map_iomem(acpi_physical_address phys,
> acpi_size size)
>
> Signed-off-by: Qian Cai <cai@xxxxxx>
> ---
> drivers/acpi/osl.c | 4 ++--
> include/acpi/acpi_io.h | 4 ++--
> 2 files changed, 4 insertions(+), 4 deletions(-)
>
> diff --git a/drivers/acpi/osl.c b/drivers/acpi/osl.c
> index cc7507091dec..9c0edf2fc0dd 100644
> --- a/drivers/acpi/osl.c
> +++ b/drivers/acpi/osl.c
> @@ -301,8 +301,8 @@ static void acpi_unmap(acpi_physical_address pg_off, void __iomem *vaddr)
> * During early init (when acpi_permanent_mmap has not been set yet) this
> * routine simply calls __acpi_map_table() to get the job done.
> */
> -void __iomem *__ref
> -acpi_os_map_iomem(acpi_physical_address phys, acpi_size size)
> +void __iomem __ref
> +*acpi_os_map_iomem(acpi_physical_address phys, acpi_size size)
> {
> struct acpi_ioremap *map;
> void __iomem *virt;
> diff --git a/include/acpi/acpi_io.h b/include/acpi/acpi_io.h
> index d0633fc1fc15..12d8bd333fe7 100644
> --- a/include/acpi/acpi_io.h
> +++ b/include/acpi/acpi_io.h
> @@ -16,8 +16,8 @@ static inline void __iomem *acpi_os_ioremap(acpi_physical_address phys,
>
> extern bool acpi_permanent_mmap;
>
> -void __iomem *__ref
> -acpi_os_map_iomem(acpi_physical_address phys, acpi_size size);
> +void __iomem __ref
> +*acpi_os_map_iomem(acpi_physical_address phys, acpi_size size);
> void __ref acpi_os_unmap_iomem(void __iomem *virt, acpi_size size);
> void __iomem *acpi_os_get_iomem(acpi_physical_address phys, unsigned int size);
>
>

Applied, thanks!