[PATCH] locking: fix mutex @key parameter kernel-doc notation

[PATCH] locking: fix mutex @key parameter kernel-doc notation

[Randy Dunlap]

From: Randy Dunlap <randy.dunlap@oracle.com>

Fix @key parameter to mutex_init() and one of its callers.

Warning(linux-2.6.26-git11//drivers/base/class.c:210): No description found for parameter 'key'

Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>
---
 drivers/base/class.c |    1 +
 kernel/mutex.c       |    1 +
 2 files changed, 2 insertions(+)

--- linux-2.6.26-git11.orig/drivers/base/class.c
+++ linux-2.6.26-git11/drivers/base/class.c
@@ -198,6 +198,7 @@ static void class_create_release(struct 
  * class_create - create a struct class structure
  * @owner: pointer to the module that is to "own" this struct class
  * @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().
--- linux-2.6.26-git11.orig/kernel/mutex.c
+++ linux-2.6.26-git11/kernel/mutex.c
@@ -34,6 +34,7 @@
 /***
  * mutex_init - initialize the mutex
  * @lock: the mutex to be initialized
+ * @key: the lock_class_key for the class; used by mutex lock debugging
  *
  * Initialize the mutex to unlocked state.
  *

Re: [PATCH] locking: fix mutex @key parameter kernel-doc notation

[Ingo Molnar]

* Randy Dunlap <randy.dunlap@oracle.com> wrote:

> From: Randy Dunlap <randy.dunlap@oracle.com>
> 
> Fix @key parameter to mutex_init() and one of its callers.
> 
> Warning(linux-2.6.26-git11//drivers/base/class.c:210): No description 
> found for parameter 'key'
> 
> Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>

applied to tip/core/urgent, thanks Randy. Greg, any objections?

	Ingo

Re: [PATCH] locking: fix mutex @key parameter kernel-doc notation

[Greg KH]

On Mon, Jul 28, 2008 at 04:52:09PM +0200, Ingo Molnar wrote:
> 
> * Randy Dunlap <randy.dunlap@oracle.com> wrote:
> 
> > From: Randy Dunlap <randy.dunlap@oracle.com>
> > 
> > Fix @key parameter to mutex_init() and one of its callers.
> > 
> > Warning(linux-2.6.26-git11//drivers/base/class.c:210): No description 
> > found for parameter 'key'
> > 
> > Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>
> 
> applied to tip/core/urgent, thanks Randy. Greg, any objections?

No objection from me:
	Acked-by: Greg Kroah-Hartman <gregkh@suse.de>

thanks,

greg k-h