Re: [PATCH -next] acpi/bus: fix doc warnings in bus.c

From: Rafael J. Wysocki
Date: Wed Jun 09 2021 - 09:09:44 EST


On Tue, Jun 8, 2021 at 4:28 AM Baokun Li <libaokun1@xxxxxxxxxx> wrote:
>
> Fixes the following W=1 kernel build warning(s):
>
> drivers/acpi/bus.c:437: warning: Function parameter or
> member 'handle' not described in 'acpi_bus_notify'
> drivers/acpi/bus.c:437: warning: Function parameter or
> member 'type' not described in 'acpi_bus_notify'
> drivers/acpi/bus.c:437: warning: Function parameter or
> member 'data' not described in 'acpi_bus_notify'
>
> Signed-off-by: Baokun Li <libaokun1@xxxxxxxxxx>
> ---
> drivers/acpi/bus.c | 3 +++
> 1 file changed, 3 insertions(+)
>
> diff --git a/drivers/acpi/bus.c b/drivers/acpi/bus.c
> index be7da23fad76..021b85ff990a 100644
> --- a/drivers/acpi/bus.c
> +++ b/drivers/acpi/bus.c
> @@ -430,6 +430,9 @@ static void acpi_bus_osc_negotiate_usb_control(void)
>
> /**
> * acpi_bus_notify
> + * @handle: Handle to acpi device.
> + * @type: ACPI device event type.
> + * @data: ACPI device data.

This just addresses specific warnings without really fixing the entire
kerneldoc.

Please either fix it entirely, or don't change it.

> * ---------------
> * Callback for all 'system-level' device notifications (values 0x00-0x7F).
> */
> --
> 2.31.1
>