Skip to contentSkip to conversation

ACPI: Add kernel-doc comments to handle_eject_request function

PATCH Applied Yang Li 3 participants 3 messages Mar 8, 2024 – Mar 13, 2024 ACPI

lore
Share & tools
lore

Yang Li

author
#0 lore raw

PATCH 1/1 ACPI: Add kernel-doc comments to handle_eject_request function

This patch adds proper kernel-doc comments to the handle_eject_request function in the ACPI dock subsystem.

---
 drivers/acpi/dock.c | 2 ++
 1 file changed, 2 insertions(+)
drivers/acpi/dock.c +2 -0
index a89bdbe00184..a7c00ef78086 100644
@@ -380,6 +380,8 @@ static int dock_in_progress(struct dock_station *ds)
 
 /**
  * handle_eject_request - handle an undock request checking for error conditions
+ * @ds: The dock station to undock.
+ * @event: The ACPI event number associated with the undock request.
  *
  * Check to make sure the dock device is still present, then undock and
  * hotremove all the devices that may need removing.
Signature · 1 line
2.20.1.7.g153144c
Acked-by on v1 1/1
#1 lore raw
Quoted 4 lines · Yang Li

This patch adds proper kernel-doc comments to the handle_eject_request function in the ACPI dock subsystem.

LGTM. Thanks.

Quoted 17 lines
---
 drivers/acpi/dock.c | 2 ++
 1 file changed, 2 insertions(+)
drivers/acpi/dock.c +2 -0
index a89bdbe00184..a7c00ef78086 100644
@@ -380,6 +380,8 @@ static int dock_in_progress(struct dock_station *ds)
 
 /**
  * handle_eject_request - handle an undock request checking for error conditions
+ * @ds: The dock station to undock.
+ * @event: The ACPI event number associated with the undock request.
  *
  * Check to make sure the dock device is still present, then undock and
  * hotremove all the devices that may need removing.
Signature · 1 line
#Randy
maintainer Applied
#2 lore raw
In reply to Yang Li
Quoted 14 lines · Yang Li

This patch adds proper kernel-doc comments to the handle_eject_request function in the ACPI dock subsystem.

---
 drivers/acpi/dock.c | 2 ++
 1 file changed, 2 insertions(+)
drivers/acpi/dock.c +0 -0
index a89bdbe00184..a7c00ef78086 100644

drivers/acpi/dock.c static int dock_in_progress(struct dock_station *ds)

Quoted 9 lines
drivers/acpi/dock.c +2 -1
@@ -380,6 +380,8 @@ static int dock_in_progress(struct dock_station *ds)
 
 /**
  * handle_eject_request - handle an undock request checking for error conditions
+ * @ds: The dock station to undock.
+ * @event: The ACPI event number associated with the undock request.
  *
  * Check to make sure the dock device is still present, then undock and
  * hotremove all the devices that may need removing.
--

Applied as 6.9-rc material with edits in the subject and changelog, thanks!