tjh.dev / kernel
Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux
1
fork

Configure Feed

Select the types of activity you want to include in your feed.

cred: fix kernel-doc warnings in cred.h

Use the correct function parameter names, function names, or kernel-doc
format, and add function return comment sections to avoid kernel-doc
warnings:

Warning: include/linux/cred.h:43 function parameter 'gi' not described
in 'get_group_info'
Warning: include/linux/cred.h:43 No description found for return value
of 'get_group_info'
Warning: include/linux/cred.h:213 No description found for return value
of 'get_cred_many'
Warning: include/linux/cred.h:260 function parameter '_cred' not described
in 'put_cred_many'
Warning: include/linux/cred.h:260 expecting prototype for put_cred().
Prototype was for put_cred_many() instead

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
[PM: subject tweak]
Signed-off-by: Paul Moore <paul@paul-moore.com>

authored by

Randy Dunlap and committed by
Paul Moore fe3c03b8 6de23f81

+7 -3
+7 -3
include/linux/cred.h
··· 33 33 34 34 /** 35 35 * get_group_info - Get a reference to a group info structure 36 - * @group_info: The group info to reference 36 + * @gi: The group info to reference 37 37 * 38 38 * This gets a reference to a set of supplementary groups. 39 39 * 40 40 * If the caller is accessing a task's credentials, they must hold the RCU read 41 41 * lock when reading. 42 + * 43 + * Returns: @gi 42 44 */ 43 45 static inline struct group_info *get_group_info(struct group_info *gi) 44 46 { ··· 211 209 * usage count. The purpose of this is to attempt to catch at compile time the 212 210 * accidental alteration of a set of credentials that should be considered 213 211 * immutable. 212 + * 213 + * Returns: @cred when the references are acquired, NULL otherwise. 214 214 */ 215 215 static inline const struct cred *get_cred_many(const struct cred *cred, int nr) 216 216 { ··· 250 246 } 251 247 252 248 /** 253 - * put_cred - Release a reference to a set of credentials 254 - * @cred: The credentials to release 249 + * put_cred_many - Release a reference to a set of credentials 250 + * @_cred: The credentials to release 255 251 * @nr: Number of references to release 256 252 * 257 253 * Release a reference to a set of credentials, deleting them when the last ref