diff options
| author | Randy Dunlap <rdunlap@infradead.org> | 2025-01-10 22:29:05 -0800 |
|---|---|---|
| committer | Andrew Morton <akpm@linux-foundation.org> | 2025-01-24 22:47:27 -0800 |
| commit | cb7c77e9c06a583a2e843554a7ef61c1f1af13f4 (patch) | |
| tree | 66663e5ff6c5f62d4cab7bb8fd28040517b6d7ba /ipc | |
| parent | 9c9ce355b1013a7ef37c06007cb8d714eaf4c303 (diff) | |
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>
Diffstat (limited to 'ipc')
| -rw-r--r-- | ipc/util.c | 11 |
1 files changed, 4 insertions, 7 deletions
diff --git a/ipc/util.c b/ipc/util.c index 05cb9de66735..cae60f11d9c2 100644 --- a/ipc/util.c +++ b/ipc/util.c @@ -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. */ |