LU-9633 ptlrpc: Add kernel doc style for ptlrpc (5)

This patch converts existing functional comments
to kernel doc style comments and removes '/**' for
comments which is not meant to be a kernel-doc comment

Test-Parameters: trivial
Signed-off-by: Arshad Hussain <arshad.hussain@aeoncomputing.com>
Change-Id: Ia025459e129fd5ab0709798f7bd4b6872fc08a94
Reviewed-on: https://review.whamcloud.com/c/fs/lustre-release/+/58861
Tested-by: jenkins <devops@whamcloud.com>
Tested-by: Maloo <maloo@whamcloud.com>
Reviewed-by: Petros Koutoupis <petros.koutoupis@hpe.com>
Reviewed-by: Anjus George <georgea@ornl.gov>
Reviewed-by: James Simmons <jsimmons@infradead.org>
Reviewed-by: Oleg Drokin <green@whamcloud.com>

diff --git a/lustre/ptlrpc/pack_generic.c b/lustre/ptlrpc/pack_generic.c
index 2e6bd4c..91e95ff 100644 (file)
--- a/lustre/ptlrpc/pack_generic.c
+++ b/lustre/ptlrpc/pack_generic.c
@@ -711,9 +711,9 @@ static inline __u32 lustre_msg_buflen_v2(struct lustre_msg_v2 *m, __u32 n)
 }
 
 /**
- * lustre_msg_buflen - return the length of buffer \a n in message \a m
- * \param m lustre_msg (request or reply) to look at
- * \param n message index (base 0)
+ * lustre_msg_buflen() - return the length of buffer @n in message @m
+ * @m: lustre_msg (request or reply) to look at
+ * @n: message index (base 0)
  *
  * returns zero for non-existent message indices
  */
@@ -1703,9 +1703,21 @@ void ptlrpc_request_set_replen(struct ptlrpc_request *req)
 EXPORT_SYMBOL(ptlrpc_request_set_replen);
 
 /**
- * Send a remote set_info_async.
+ * do_set_info_async() - Send a remote set_info_async.
+ * @imp: import object
+ * @opcode: operation type
+ * @version: operation version
+ * @keylen: length of key
+ * @key: pointer to key
+ * @vallen: length of value
+ * @val: pointer to value
+ * @set: pointer to ptlrpc_request_set (request to be added)
  *
  * This may go from client to server or server to client.
+ *
+ * Return:
+ * * %0 on success
+ * * %negative on failure
  */
 int do_set_info_async(struct obd_import *imp,
                      int opcode, int version,

diff --git a/lustre/ptlrpc/ptlrpcd.c b/lustre/ptlrpc/ptlrpcd.c
index bf6a530..e09bff1 100644 (file)
--- a/lustre/ptlrpc/ptlrpcd.c
+++ b/lustre/ptlrpc/ptlrpcd.c
@@ -166,7 +166,7 @@ ptlrpcd_select_pc(struct ptlrpc_request *req)
        return &pd->pd_threads[idx];
 }
 
-/**
+/*
  * Return transferred RPCs count.
  */
 static int ptlrpcd_steal_rqset(struct ptlrpc_request_set *des,
@@ -191,6 +191,9 @@ static int ptlrpcd_steal_rqset(struct ptlrpc_request_set *des,
 }
 
 /**
+ * ptlrpcd_add_req() - Requests that are added to the ptlrpcd queue
+ * @req: request to add to ptlrpcd
+ *
  * Requests that are added to the ptlrpcd queue are sent via
  * ptlrpcd_check->ptlrpc_check_set().
  */
@@ -350,9 +353,15 @@ static int ptlrpcd_check(struct lu_env *env, struct ptlrpcd_ctl *pc)
 }
 
 /**
- * Main ptlrpcd thread.
+ * ptlrpcd() - Main ptlrpcd thread.
+ * @arg: pointer to struct ptlrpcd_ctl
+ *
  * ptlrpc's code paths like to execute in process context, so we have this
  * thread which spins on a set which contains the rpcs and sends them.
+ *
+ * Return:
+ * * %0 on success
+ * * %negative on failure
  */
 static int ptlrpcd(void *arg)
 {