Commit 33c0c9bd authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by Greg Kroah-Hartman
Browse files

drivers: base: fix some kernel-doc markups 



class_create is actually defined at the header. Fix the
markup there and add a new one at the right place.

While here, also fix some markups for functions that have
different names between their prototypes and kernel-doc
comments.

Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/2fb6efd6a1f90d69ff73bf579566079cbb051e15.1603469755.git.mchehab+huawei@kernel.org


Signed-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
parent 7008e58c

drivers/base/class.c

+1 −1
Original line number Diff line number Diff line
@@ -210,7 +210,7 @@ static void class_create_release(struct class *cls) 
}



/**

 * class_create - create a struct class structure

 * __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

drivers/base/devres.c

+1 −1
Original line number Diff line number Diff line
@@ -149,7 +149,7 @@ void * __devres_alloc_node(dr_release_t release, size_t size, gfp_t gfp, int nid 
EXPORT_SYMBOL_GPL(__devres_alloc_node);

#else

/**

 * devres_alloc - Allocate device resource data

 * devres_alloc_node - Allocate device resource data

 * @release: Release function devres will be associated with

 * @size: Allocation size

 * @gfp: Allocation flags

drivers/base/firmware_loader/fallback.c

+1 −1
Original line number Diff line number Diff line
@@ -128,7 +128,7 @@ static ssize_t timeout_show(struct class *class, struct class_attribute *attr, 
}



/**

 * firmware_timeout_store() - set number of seconds to wait for firmware

 * timeout_store() - set number of seconds to wait for firmware

 * @class: device class pointer

 * @attr: device attribute pointer

 * @buf: buffer to scan for timeout value

include/linux/device/class.h

+14 −0
Original line number Diff line number Diff line
@@ -256,6 +256,20 @@ extern void class_destroy(struct class *cls); 


/* This is a #define to keep the compiler from merging different

 * instances of the __key variable */



/**

 * 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.

 *

 * This is used to create a struct class pointer that can then be used

 * in calls to device_create().

 *

 * Returns &struct class pointer on success, or ERR_PTR() on error.

 *

 * Note, the pointer created here is to be destroyed when finished by

 * making a call to class_destroy().

 */

#define class_create(owner, name)		\

({						\

	static struct lock_class_key __key;	\

CRA Git | Maintained and supported by SUSTech CRA and CCSE