Skip to content

Commit cb7c77e

Browse files
rddunlapakpm00
authored andcommitted
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>
1 parent 9c9ce35 commit cb7c77e

File tree

1 file changed

+4
-7
lines changed

1 file changed

+4
-7
lines changed

ipc/util.c

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -615,12 +615,11 @@ void ipc64_perm_to_ipc_perm(struct ipc64_perm *in, struct ipc_perm *out)
615615
}
616616

617617
/**
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.
619620
* @ids: ipc identifier set
620621
* @id: ipc id to look for
621622
*
622-
* Look for an id in the ipc ids idr and return associated ipc object.
623-
*
624623
* Call inside the RCU critical section.
625624
* The ipc object is *not* locked on exit.
626625
*/
@@ -637,13 +636,11 @@ struct kern_ipc_perm *ipc_obtain_object_idr(struct ipc_ids *ids, int id)
637636
}
638637

639638
/**
640-
* ipc_obtain_object_check
639+
* ipc_obtain_object_check - Similar to ipc_obtain_object_idr() but
640+
* also checks the ipc object sequence number.
641641
* @ids: ipc identifier set
642642
* @id: ipc id to look for
643643
*
644-
* Similar to ipc_obtain_object_idr() but also checks the ipc object
645-
* sequence number.
646-
*
647644
* Call inside the RCU critical section.
648645
* The ipc object is *not* locked on exit.
649646
*/

0 commit comments

Comments
 (0)