Skip to contentSkip to conversation

acpi/bus: fix doc warnings in bus.c

PATCH In review Baokun Li 2 participants 2 messages Jun 8, 2021 – Jun 9, 2021 ACPI

lore
Share & tools
lore

Baokun Li

author
#0 lore raw

PATCH 1/1 acpi/bus: fix doc warnings in bus.c

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'

---
 drivers/acpi/bus.c | 3 +++
 1 file changed, 3 insertions(+)
drivers/acpi/bus.c +3 -0
index be7da23fad76..021b85ff990a 100644
@@ -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).
  */
Signature · 1 line
2.31.1
#1 lore raw
Quoted 20 lines · Baokun Li

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'

---
 drivers/acpi/bus.c | 3 +++
 1 file changed, 3 insertions(+)
drivers/acpi/bus.c +0 -0
index be7da23fad76..021b85ff990a 100644

drivers/acpi/bus.c static void acpi_bus_osc_negotiate_usb_control(void) · line 435

Quoted 6 lines
drivers/acpi/bus.c +3 -0
@@ -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.

Quoted 6 lines
drivers/acpi/bus.c +0 -1
  * ---------------
  * Callback for all 'system-level' device notifications (values 0x00-0x7F).
  */
--

2.31.1