diff mbox series

driver core: class: fix documentation for class_create()

Message ID 20230327081828.1087364-1-gregkh@linuxfoundation.org
State New
Headers
Series driver core: class: fix documentation for class_create() |

Commit Message

Greg KH March 27, 2023, 8:18 a.m. UTC 
  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@kernel.org>
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Fixes: dcfbb67e48a2 ("driver core: class: use lock_class_key already present in struct subsys_private")
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
---
 drivers/base/class.c | 1 -
 1 file changed, 1 deletion(-)

Comments

Rafael J. Wysocki March 27, 2023, 11:41 a.m. UTC | #1 
On Mon, Mar 27, 2023 at 10:18 AM Greg Kroah-Hartman
<gregkh@linuxfoundation.org> 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@kernel.org>
> Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
> Fixes: dcfbb67e48a2 ("driver core: class: use lock_class_key already present in struct subsys_private")
> Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>

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

> ---
>  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
>
diff mbox series

Patch

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().