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

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: I1eabbb64bc6c10dfd2e7f08c7db66566cd92b345
Reviewed-on: https://review.whamcloud.com/c/fs/lustre-release/+/58862
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/batch.c b/lustre/ptlrpc/batch.c
index 7c1d091..15bed34 100644 (file)
--- a/lustre/ptlrpc/batch.c
+++ b/lustre/ptlrpc/batch.c
@@ -63,7 +63,7 @@ struct batch_work_resend {
        int                              bwr_index;
 };
 
-/**
+/*
  * Prepare inline update request
  *
  * Prepare BUT update ptlrpc inline request, and the request usuanlly includes
@@ -238,7 +238,7 @@ static int batch_update_buffer_create(struct batch_update_head *head,
        return 0;
 }
 
-/**
+/*
  * Destroy an @object_update_callback.
  */
 static void object_update_callback_fini(struct object_update_callback *ouc)
@@ -248,7 +248,7 @@ static void object_update_callback_fini(struct object_update_callback *ouc)
        OBD_FREE_PTR(ouc);
 }
 
-/**
+/*
  * Insert an @object_update_callback into the the @batch_update_head.
  *
  * Usually each update in @batch_update_head will have one correspondent
@@ -273,7 +273,7 @@ batch_insert_update_callback(struct batch_update_head *head, void *data,
        return 0;
 }
 
-/**
+/*
  * Allocate and initialize batch update request.
  *
  * @batch_update_head is being used to track updates being executed on

diff --git a/lustre/ptlrpc/sec_config.c b/lustre/ptlrpc/sec_config.c
index 6d0b92c..4a14953 100644 (file)
--- a/lustre/ptlrpc/sec_config.c
+++ b/lustre/ptlrpc/sec_config.c
@@ -359,7 +359,14 @@ int sptlrpc_rule_set_merge(struct sptlrpc_rule_set *rset,
 EXPORT_SYMBOL(sptlrpc_rule_set_merge);
 
 /**
- * given from/to/nid, determine a matching flavor in ruleset.
+ * sptlrpc_rule_set_choose() - given from/to/nid, determine a matching flavor
+ * in ruleset.
+ * @rset: pointer to rule set to be searched
+ * @from: where request is coming (client, MDT, OST)
+ * @to: where request is going
+ * @nid: pointer to lnet_nid (network identifier)
+ * @sf: Choosen flavor is stored [out]
+ *
  * return 1 if a match found, otherwise return 0.
  */
 int sptlrpc_rule_set_choose(struct sptlrpc_rule_set *rset,
@@ -576,8 +583,8 @@ static int sptlrpc_conf_merge_rule(struct sptlrpc_conf *conf,
        return sptlrpc_rule_set_merge(rule_set, rule);
 }
 
-/**
- * process one LCFG_SPTLRPC_CONF record. if \a conf is NULL, we
+/*
+ * process one LCFG_SPTLRPC_CONF record. if @conf is NULL, we
  * find one through the target name in the record inside conf_lock;
  * otherwise means caller already hold conf_lock.
  */
@@ -612,6 +619,14 @@ static int __sptlrpc_process_config(char *target, const char *fsname,
        RETURN(rc);
 }
 
+/**
+ * sptlrpc_process_config() - process a config record related to the sec policy
+ * @lcfg: pointer to struct lustre_cfg (config record)
+ *
+ * Return:
+ * * %0 on success
+ * * %negative on failure
+ */
 int sptlrpc_process_config(struct lustre_cfg *lcfg)
 {
        char fsname[MTI_NAME_MAXLEN];
@@ -836,7 +851,7 @@ out:
        flavor_set_flags(sf, from, to, 1);
 }
 
-/**
+/*
  * called by target devices, determine the expected flavor from
  * certain peer (from, nid).
  */
@@ -852,6 +867,9 @@ void sptlrpc_target_choose_flavor(struct sptlrpc_rule_set *rset,
 #define SEC_ADAPT_DELAY         (10)
 
 /**
+ * sptlrpc_conf_client_adapt() - notify the sptlrpc config has changed
+ * @obd: pointer to obd device (client side, OSC/MDC)
+ *
  * called by client devices, notify the sptlrpc config has changed and
  * do import_sec_adapt later.
  */
@@ -881,7 +899,7 @@ void sptlrpc_conf_client_adapt(struct obd_device *obd)
 }
 EXPORT_SYMBOL(sptlrpc_conf_client_adapt);
 
-/**
+/*
  * called by target devices, extract sptlrpc rules which applies to
  * this target, to be used for future rpc flavor checking.
  */