2024-03-08 07:32:31

by Yang Li

[permalink] [raw]
Subject: [PATCH -next] 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.

Signed-off-by: Yang Li <[email protected]>
---
drivers/acpi/dock.c | 2 ++
1 file changed, 2 insertions(+)

diff --git a/drivers/acpi/dock.c b/drivers/acpi/dock.c
index a89bdbe00184..a7c00ef78086 100644
--- a/drivers/acpi/dock.c
+++ b/drivers/acpi/dock.c
@@ -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.
--
2.20.1.7.g153144c



2024-03-08 16:02:40

by Randy Dunlap

[permalink] [raw]
Subject: Re: [PATCH -next] ACPI: Add kernel-doc comments to handle_eject_request function



On 3/7/24 23:32, Yang Li wrote:
> This patch adds proper kernel-doc comments to the
> handle_eject_request function in the ACPI dock subsystem.
>
> Signed-off-by: Yang Li <[email protected]>

LGTM. Thanks.

Acked-by: Randy Dunlap <[email protected]>

> ---
> drivers/acpi/dock.c | 2 ++
> 1 file changed, 2 insertions(+)
>
> diff --git a/drivers/acpi/dock.c b/drivers/acpi/dock.c
> index a89bdbe00184..a7c00ef78086 100644
> --- a/drivers/acpi/dock.c
> +++ b/drivers/acpi/dock.c
> @@ -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.

--
#Randy

2024-03-13 20:04:09

by Rafael J. Wysocki

[permalink] [raw]
Subject: Re: [PATCH -next] ACPI: Add kernel-doc comments to handle_eject_request function

On Fri, Mar 8, 2024 at 8:32 AM Yang Li <[email protected]> wrote:
>
> This patch adds proper kernel-doc comments to the
> handle_eject_request function in the ACPI dock subsystem.
>
> Signed-off-by: Yang Li <[email protected]>
> ---
> drivers/acpi/dock.c | 2 ++
> 1 file changed, 2 insertions(+)
>
> diff --git a/drivers/acpi/dock.c b/drivers/acpi/dock.c
> index a89bdbe00184..a7c00ef78086 100644
> --- a/drivers/acpi/dock.c
> +++ b/drivers/acpi/dock.c
> @@ -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!