torvalds/linux
torvalds/linux
2
0
Fork 0
mirror of git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git synced 2025-09-04 20:19:47 +08:00
Code

ipc/util.c: complete the kernel-doc function descriptions

Browse Source 
Move the function descriptive comments so that they conform to
kernel-doc format, eliminating the kernel-doc warnings.

util.c:618: warning: missing initial short description on line:
 * ipc_obtain_object_idr
util.c:640: warning: missing initial short description on line:
 * ipc_obtain_object_check

Link: https://lkml.kernel.org/r/20250111062905.910576-1-rdunlap@infradead.org
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
This commit is contained in:
Randy Dunlap 2025-01-10 22:29:05 -08:00 committed by Andrew Morton
parent 9c9ce355b1
commit cb7c77e9c0
1 changed files with 4 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
ipc/util.c
View File

@ -615,12 +615,11 @@ void ipc64_perm_to_ipc_perm(struct ipc64_perm *in, struct ipc_perm *out)
} }
/** /**
* ipc_obtain_object_idr * ipc_obtain_object_idr - Look for an id in the ipc ids idr and
* return associated ipc object.
* @ids: ipc identifier set * @ids: ipc identifier set
* @id: ipc id to look for * @id: ipc id to look for
* *
* Look for an id in the ipc ids idr and return associated ipc object.
*
* Call inside the RCU critical section. * Call inside the RCU critical section.
* The ipc object is *not* locked on exit. * The ipc object is *not* locked on exit.
*/ */
@ -637,13 +636,11 @@ struct kern_ipc_perm *ipc_obtain_object_idr(struct ipc_ids *ids, int id)
} }
/** /**
* ipc_obtain_object_check * ipc_obtain_object_check - Similar to ipc_obtain_object_idr() but
* also checks the ipc object sequence number.
* @ids: ipc identifier set * @ids: ipc identifier set
* @id: ipc id to look for * @id: ipc id to look for
* *
* Similar to ipc_obtain_object_idr() but also checks the ipc object
* sequence number.
*
* Call inside the RCU critical section. * Call inside the RCU critical section.
* The ipc object is *not* locked on exit. * The ipc object is *not* locked on exit.
*/ */