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.

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: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>

authored by

Randy Dunlap and committed by
Andrew Morton cb7c77e9 9c9ce355

+4 -7
+4 -7
ipc/util.c
··· 615 615 } 616 616 617 617 /** 618 - * ipc_obtain_object_idr 618 + * ipc_obtain_object_idr - Look for an id in the ipc ids idr and 619 + * return associated ipc object. 619 620 * @ids: ipc identifier set 620 621 * @id: ipc id to look for 621 - * 622 - * Look for an id in the ipc ids idr and return associated ipc object. 623 622 * 624 623 * Call inside the RCU critical section. 625 624 * The ipc object is *not* locked on exit. ··· 636 637 } 637 638 638 639 /** 639 - * ipc_obtain_object_check 640 + * ipc_obtain_object_check - Similar to ipc_obtain_object_idr() but 641 + * also checks the ipc object sequence number. 640 642 * @ids: ipc identifier set 641 643 * @id: ipc id to look for 642 - * 643 - * Similar to ipc_obtain_object_idr() but also checks the ipc object 644 - * sequence number. 645 644 * 646 645 * Call inside the RCU critical section. 647 646 * The ipc object is *not* locked on exit.