[PATCH] ipc/sem: Fix kernel-doc notation of perform_atomic_semop_slow()

Manuel Ebner posted 1 patch 6 days, 9 hours ago
ipc/sem.c | 10 ++++++++--
1 file changed, 8 insertions(+), 2 deletions(-)
[PATCH] ipc/sem: Fix kernel-doc notation of perform_atomic_semop_slow()
Posted by Manuel Ebner 6 days, 9 hours ago
Adopt strict kernel-doc notation to make doc recognizable, this fixes:

$ ./scripts/kernel-doc -none ipc/sem.c
Warning: ipc/sem.c:629 This comment starts with '/**', but isn't a kernel-doc comment. Refer to Documentation/doc-guide/kernel-doc.rst
 * perform_atomic_semop[_slow] - Attempt to perform semaphore

Signed-off-by: Manuel Ebner <manuelebnerli@mailbox.org>
---
 ipc/sem.c | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)

diff --git a/ipc/sem.c b/ipc/sem.c
index 5ec41de7e85b..642be4170065 100644
--- a/ipc/sem.c
+++ b/ipc/sem.c
@@ -627,8 +627,8 @@ SYSCALL_DEFINE3(semget, key_t, key, int, nsems, int, semflg)
 }
 
 /**
- * perform_atomic_semop[_slow] - Attempt to perform semaphore
- *                               operations on a given array.
+ * perform_atomic_semop_slow - Attempt to perform semaphore
+ *                             operations on a given array.
  * @sma: semaphore array
  * @q: struct sem_queue that describes the operation
  *
@@ -642,6 +642,8 @@ SYSCALL_DEFINE3(semget, key_t, key, int, nsems, int, semflg)
  * Returns 0 if the operation was possible.
  * Returns 1 if the operation is impossible, the caller must sleep.
  * Returns <0 for error codes.
+ *
+ * This description is also valid for perform_atomic_semop(), the function below
  */
 static int perform_atomic_semop_slow(struct sem_array *sma, struct sem_queue *q)
 {
@@ -716,6 +718,10 @@ static int perform_atomic_semop_slow(struct sem_array *sma, struct sem_queue *q)
 	return result;
 }
 
+/*
+ * The description of this functions is the same as the one for
+ * perform_atomic_semop_slow(), see the kernel-doc above.
+ */
 static int perform_atomic_semop(struct sem_array *sma, struct sem_queue *q)
 {
 	int result, sem_op, nsops;
-- 
2.55.0