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

Message ID 20210608023733.2745553-1-libaokun1@huawei.com
State New
Headers show
Series
  • [-next] acpi/bus: fix doc warnings in bus.c
Related show

Commit Message

Baokun Li June 8, 2021, 2:37 a.m.
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@huawei.com>
---
 drivers/acpi/bus.c | 3 +++
 1 file changed, 3 insertions(+)

Comments

Rafael J. Wysocki June 9, 2021, 1:09 p.m. | #1
On Tue, Jun 8, 2021 at 4:28 AM Baokun Li <libaokun1@huawei.com> 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@huawei.com>

> ---

>  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

>

Patch

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.
  * ---------------
  * Callback for all 'system-level' device notifications (values 0x00-0x7F).
  */