LU-9633 lod: Add kernel doc style for lod (Part 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: Ia3a4d995bc21ae682254a194d9e0ff9b8ba7ecb3
Reviewed-on: https://review.whamcloud.com/c/fs/lustre-release/+/58778
Tested-by: jenkins <devops@whamcloud.com>
Tested-by: Maloo <maloo@whamcloud.com>
Reviewed-by: Anjus George <georgea@ornl.gov>
Reviewed-by: Petros Koutoupis <petros.koutoupis@hpe.com>
Reviewed-by: James Simmons <jsimmons@infradead.org>
Reviewed-by: Oleg Drokin <green@whamcloud.com>

diff --git a/lustre/lod/lproc_lod.c b/lustre/lod/lproc_lod.c
index 0a8fb0f..ddf8ec1 100644 (file)
--- a/lustre/lod/lproc_lod.c
+++ b/lustre/lod/lproc_lod.c
@@ -85,9 +85,7 @@ static ssize_t dom_stripesize_store(struct kobject *kobj,
 /* Old attribute name is still supported */
 LUSTRE_RW_ATTR(dom_stripesize);
 
-/**
- * Show DoM maximum allowed stripe size.
- */
+/* Show DoM maximum allowed stripe size. */
 static ssize_t dom_stripesize_max_kb_show(struct kobject *kobj,
                                          struct attribute *attr,
                                          char *buf)
@@ -99,9 +97,7 @@ static ssize_t dom_stripesize_max_kb_show(struct kobject *kobj,
                         lod->lod_dom_stripesize_max_kb);
 }
 
-/**
- * Set DoM maximum allowed stripe size.
- */
+/* Set DoM maximum allowed stripe size. */
 static ssize_t dom_stripesize_max_kb_store(struct kobject *kobj,
                                           struct attribute *attr,
                                           const char *buffer, size_t count)
@@ -122,9 +118,7 @@ static ssize_t dom_stripesize_max_kb_store(struct kobject *kobj,
 }
 LUSTRE_RW_ATTR(dom_stripesize_max_kb);
 
-/**
- * Show DoM default stripe size.
- */
+/* Show DoM default stripe size. */
 static ssize_t dom_stripesize_cur_kb_show(struct kobject *kobj,
                                          struct attribute *attr,
                                          char *buf)
@@ -138,9 +132,7 @@ static ssize_t dom_stripesize_cur_kb_show(struct kobject *kobj,
 
 LUSTRE_RO_ATTR(dom_stripesize_cur_kb);
 
-/**
- * Show DoM threshold.
- */
+/* Show DoM threshold. */
 static ssize_t dom_threshold_free_mb_show(struct kobject *kobj,
                                          struct attribute *attr, char *buf)
 {
@@ -151,9 +143,7 @@ static ssize_t dom_threshold_free_mb_show(struct kobject *kobj,
                         lod->lod_dom_threshold_free_mb);
 }
 
-/**
- * Set DoM default stripe size.
- */
+/* Set DoM default stripe size. */
 static ssize_t dom_threshold_free_mb_store(struct kobject *kobj,
                                           struct attribute *attr,
                                           const char *buffer, size_t count)
@@ -211,9 +201,7 @@ static ssize_t stripesize_store(struct kobject *kobj, struct attribute *attr,
 
 LUSTRE_RW_ATTR(stripesize);
 
-/**
- * Show default stripe offset.
- */
+/* Show default stripe offset. */
 static ssize_t stripeoffset_show(struct kobject *kobj, struct attribute *attr,
                                 char *buf)
 {
@@ -225,7 +213,7 @@ static ssize_t stripeoffset_show(struct kobject *kobj, struct attribute *attr,
                lod->lod_ost_descs.ltd_lov_desc.ld_default_stripe_offset);
 }
 
-/**
+/*
  * Set default stripe offset.
  *
  * Usually contains -1 allowing Lustre to balance objects among OST
@@ -352,9 +340,7 @@ static ssize_t max_stripes_per_mdt_store(struct kobject *kobj,
 LUSTRE_RW_ATTR(max_stripes_per_mdt);
 
 
-/**
- * Show default striping pattern (LOV_PATTERN_*).
- */
+/* Show default striping pattern (LOV_PATTERN_*). */
 static ssize_t __stripetype_show(struct kobject *kobj, struct attribute *attr,
                                 char *buf, bool is_mdt)
 {
@@ -379,9 +365,7 @@ static ssize_t stripetype_show(struct kobject *kobj, struct attribute *attr,
        return __stripetype_show(kobj, attr, buf, false);
 }
 
-/**
- * Set default striping pattern (a number, not a human-readable string).
- */
+/* Set default striping pattern (a number, not a human-readable string). */
 static ssize_t __stripetype_store(struct kobject *kobj, struct attribute *attr,
                                  const char *buffer, size_t count, bool is_mdt)
 {
@@ -424,9 +408,7 @@ static ssize_t stripetype_store(struct kobject *kobj,
 LUSTRE_RW_ATTR(mdt_stripetype);
 LUSTRE_RW_ATTR(stripetype);
 
-/**
- * Show default number of stripes.
- */
+/* Show default number of stripes. */
 static ssize_t __stripecount_show(struct kobject *kobj, struct attribute *attr,
                                  char *buf, bool is_mdt)
 {
@@ -452,9 +434,7 @@ static ssize_t stripecount_show(struct kobject *kobj, struct attribute *attr,
        return __stripecount_show(kobj, attr, buf, false);
 }
 
-/**
- * Set default number of stripes.
- */
+/* Set default number of stripes. */
 static ssize_t __stripecount_store(struct kobject *kobj, struct attribute *attr,
                                   const char *buffer, size_t count,
                                   bool is_mdt)
@@ -497,9 +477,7 @@ static ssize_t stripecount_store(struct kobject *kobj,
 LUSTRE_RW_ATTR(mdt_stripecount);
 LUSTRE_RW_ATTR(stripecount);
 
-/**
- * Show number of targets.
- */
+/* Show number of targets. */
 static ssize_t __numobd_show(struct kobject *kobj, struct attribute *attr,
                             char *buf, bool is_mdt)
 {
@@ -528,9 +506,7 @@ static ssize_t numobd_show(struct kobject *kobj, struct attribute *attr,
 LUSTRE_RO_ATTR(mdt_numobd);
 LUSTRE_RO_ATTR(numobd);
 
-/**
- * Show number of active targets.
- */
+/* Show number of active targets. */
 static ssize_t __activeobd_show(struct kobject *kobj, struct attribute *attr,
                                char *buf, bool is_mdt)
 {
@@ -559,9 +535,7 @@ static ssize_t activeobd_show(struct kobject *kobj, struct attribute *attr,
 LUSTRE_RO_ATTR(mdt_activeobd);
 LUSTRE_RO_ATTR(activeobd);
 
-/**
- * Show UUID of LOD device.
- */
+/* Show UUID of LOD device. */
 static ssize_t desc_uuid_show(struct kobject *kobj, struct attribute *attr,
                              char *buf)
 {
@@ -574,7 +548,7 @@ static ssize_t desc_uuid_show(struct kobject *kobj, struct attribute *attr,
 }
 LUSTRE_RO_ATTR(desc_uuid);
 
-/**
+/*
  * Show QoS priority parameter.
  *
  * The printed value is a percentage value (0-100%) indicating the priority
@@ -608,7 +582,7 @@ static ssize_t qos_prio_free_show(struct kobject *kobj,
        return __qos_prio_free_show(kobj, attr, buf, false);
 }
 
-/**
+/*
  * Set QoS free space priority parameter.
  *
  * Set the relative priority of free OST space compared to OST load when OSTs
@@ -670,9 +644,7 @@ static ssize_t qos_prio_free_store(struct kobject *kobj, struct attribute *attr,
 LUSTRE_RW_ATTR(mdt_qos_prio_free);
 LUSTRE_RW_ATTR(qos_prio_free);
 
-/**
- * Show threshold for "same space on all OSTs" rule.
- */
+/* Show threshold for "same space on all OSTs" rule. */
 static ssize_t __qos_threshold_rr_show(struct kobject *kobj,
                                       struct attribute *attr, char *buf,
                                       bool is_mdt)
@@ -700,7 +672,7 @@ static ssize_t qos_threshold_rr_show(struct kobject *kobj,
        return __qos_threshold_rr_show(kobj, attr, buf, false);
 }
 
-/**
+/*
  * Set threshold for "same space on all OSTs" rule.
  *
  * This sets the maximum percentage difference of free space between the most
@@ -762,8 +734,7 @@ static ssize_t qos_threshold_rr_store(struct kobject *kobj,
 LUSTRE_RW_ATTR(mdt_qos_threshold_rr);
 LUSTRE_RW_ATTR(qos_threshold_rr);
 
-/**
- * Show expiration period used to refresh cached statfs data, which
+/* Show expiration period used to refresh cached statfs data, which
  * is used to implement QoS/RR striping allocation algorithm.
  */
 static ssize_t __qos_maxage_show(struct kobject *kobj, struct attribute *attr,
@@ -791,9 +762,7 @@ static ssize_t qos_maxage_show(struct kobject *kobj, struct attribute *attr,
        return __qos_maxage_show(kobj, attr, buf, true);
 }
 
-/**
- * Set expiration period used to refresh cached statfs data.
- */
+/* Set expiration period used to refresh cached statfs data. */
 static ssize_t __qos_maxage_store(struct kobject *kobj, struct attribute *attr,
                                  const char *buffer, size_t count, bool is_mdt)
 {
@@ -943,13 +912,14 @@ static void *lod_osts_seq_next(struct seq_file *p, void *v, loff_t *pos)
 }
 
 /**
- * Show active/inactive status for OST found by lod_osts_seq_next().
- *
- * \param[in] m                seq file
- * \param[in] v                unused for single entry
+ * lod_tgts_seq_show() - Show active/inactive status for OST found by
+ * lod_osts_seq_next().
+ * @p: seq file
+ * @v: unused for single entry
  *
- * \retval 0           on success
- * \retval negative    error code if failed
+ * Return:
+ * * %0                on success
+ * * %negative error code if failed
  */
 static int lod_tgts_seq_show(struct seq_file *p, void *v)
 {
@@ -1021,9 +991,7 @@ static int lod_osts_seq_open(struct inode *inode, struct file *file)
        return 0;
 }
 
-/**
- * Show whether special failout mode for testing is enabled or not.
- */
+/* Show whether special failout mode for testing is enabled or not. */
 static ssize_t lmv_failout_show(struct kobject *kobj, struct attribute *attr,
                                char *buf)
 {
@@ -1034,7 +1002,7 @@ static ssize_t lmv_failout_show(struct kobject *kobj, struct attribute *attr,
        return scnprintf(buf, PAGE_SIZE, "%d\n", lod->lod_lmv_failout ? 1 : 0);
 }
 
-/**
+/*
  * Enable/disable a special failout mode for testing.
  *
  * This determines whether the LMV will try to continue processing a striped
@@ -1524,12 +1492,12 @@ static struct ldebugfs_vars ldebugfs_lod_vars[] = {
 };
 
 /**
- * Initialize procfs entries for LOD.
+ * lod_procfs_init() - Initialize procfs entries for LOD.
+ * @lod: LOD device
  *
- * \param[in] lod      LOD device
- *
- * \retval 0           on success
- * \retval negative    error code if failed
+ * Return:
+ * * %0 on success
+ * * %negative error code if failed
  */
 int lod_procfs_init(struct lod_device *lod)
 {
@@ -1643,9 +1611,8 @@ out:
 }
 
 /**
- * Cleanup procfs entries registred for LOD.
- *
- * \param[in] lod      LOD device
+ * lod_procfs_fini() - Cleanup procfs entries registred for LOD.
+ * @lod: LOD device
  */
 void lod_procfs_fini(struct lod_device *lod)
 {