Commit cb7c77e9 authored by Randy Dunlap's avatar Randy Dunlap Committed by Andrew Morton
Browse files

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

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: default avatarRandy Dunlap <rdunlap@infradead.org>
Signed-off-by: default avatarAndrew Morton <akpm@linux-foundation.org>
parent 9c9ce355

ipc/util.c

+4 −7
Original line number Diff line number Diff line
@@ -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

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

 * 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

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

 * The ipc object is *not* locked on exit.

 */