Re: [PATCH] driver core: class: fix documentation for class_create()

From: Rafael J. Wysocki
Date: Mon Mar 27 2023 - 07:42:19 EST


On Mon, Mar 27, 2023 at 10:18 AM Greg Kroah-Hartman
<gregkh@xxxxxxxxxxxxxxxxxxx> wrote:
>
> In commit dcfbb67e48a2 ("driver core: class: use lock_class_key already
> present in struct subsys_private") we removed the key parameter to the
> function class_create() but forgot to remove it from the kerneldoc,
> which causes a build warning. Fix that up by removing the key parameter
> from the documentation as it is now gone.
>
> Cc: "Rafael J. Wysocki" <rafael@xxxxxxxxxx>
> Reported-by: Stephen Rothwell <sfr@xxxxxxxxxxxxxxxx>
> Fixes: dcfbb67e48a2 ("driver core: class: use lock_class_key already present in struct subsys_private")
> Signed-off-by: Greg Kroah-Hartman <gregkh@xxxxxxxxxxxxxxxxxxx>

Acked-by: Rafael J. Wysocki <rafael@xxxxxxxxxx>

> ---
> drivers/base/class.c | 1 -
> 1 file changed, 1 deletion(-)
>
> diff --git a/drivers/base/class.c b/drivers/base/class.c
> index dbaeb79ae917..0f8938a17144 100644
> --- a/drivers/base/class.c
> +++ b/drivers/base/class.c
> @@ -223,7 +223,6 @@ static void class_create_release(struct class *cls)
> /**
> * class_create - create a struct class structure
> * @name: pointer to a string for the name of this class.
> - * @key: the lock_class_key for this class; used by mutex lock debugging
> *
> * This is used to create a struct class pointer that can then be used
> * in calls to device_create().
> --
> 2.40.0
>