staging: lustre: libcfs: fixup all header block comments
authorJames Simmons <jsimmons@infradead.org>
Fri, 18 Nov 2016 16:48:35 +0000 (11:48 -0500)
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Sat, 19 Nov 2016 13:13:44 +0000 (14:13 +0100)
Properly format the incorrect comments sections
that were reported by checkpatch.

Signed-off-by: James Simmons <jsimmons@infradead.org>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
drivers/staging/lustre/include/linux/libcfs/libcfs_crypto.h
drivers/staging/lustre/include/linux/libcfs/libcfs_fail.h
drivers/staging/lustre/include/linux/libcfs/libcfs_hash.h
drivers/staging/lustre/include/linux/libcfs/libcfs_private.h
drivers/staging/lustre/include/linux/libcfs/libcfs_string.h

index 02be7d7608a582170a895de4b910a3afe7a158c5..a0865e517b65f74cad3ea110d3d4dd455e77a07b 100644 (file)
 #define _LIBCFS_CRYPTO_H
 
 struct cfs_crypto_hash_type {
-       char            *cht_name;      /**< hash algorithm name, equal to
-                                        * format name for crypto api */
-       unsigned int    cht_key;        /**< init key by default (valid for
-                                        * 4 bytes context like crc32, adler */
+       char            *cht_name;      /*< hash algorithm name, equal to
+                                        * format name for crypto api
+                                        */
+       unsigned int    cht_key;        /*< init key by default (valid for
+                                        * 4 bytes context like crc32, adler
+                                        */
        unsigned int    cht_size;       /**< hash digest size */
 };
 
index bdbbe934584c707da7f03d474b974f5732e11eb7..b1658c8ddcd67bfc24d267038abcac207afc042f 100644 (file)
@@ -103,22 +103,28 @@ static inline int cfs_fail_check_set(__u32 id, __u32 value,
 #define CFS_FAIL_CHECK_QUIET(id) \
        cfs_fail_check_set(id, 0, CFS_FAIL_LOC_NOSET, 1)
 
-/* If id hit cfs_fail_loc and cfs_fail_val == (-1 or value) return 1,
- * otherwise return 0 */
+/*
+ * If id hit cfs_fail_loc and cfs_fail_val == (-1 or value) return 1,
+ * otherwise return 0
+ */
 #define CFS_FAIL_CHECK_VALUE(id, value) \
        cfs_fail_check_set(id, value, CFS_FAIL_LOC_VALUE, 0)
 #define CFS_FAIL_CHECK_VALUE_QUIET(id, value) \
        cfs_fail_check_set(id, value, CFS_FAIL_LOC_VALUE, 1)
 
-/* If id hit cfs_fail_loc, cfs_fail_loc |= value and return 1,
- * otherwise return 0 */
+/*
+ * If id hit cfs_fail_loc, cfs_fail_loc |= value and return 1,
+ * otherwise return 0
+ */
 #define CFS_FAIL_CHECK_ORSET(id, value) \
        cfs_fail_check_set(id, value, CFS_FAIL_LOC_ORSET, 0)
 #define CFS_FAIL_CHECK_ORSET_QUIET(id, value) \
        cfs_fail_check_set(id, value, CFS_FAIL_LOC_ORSET, 1)
 
-/* If id hit cfs_fail_loc, cfs_fail_loc = value and return 1,
- * otherwise return 0 */
+/*
+ * If id hit cfs_fail_loc, cfs_fail_loc = value and return 1,
+ * otherwise return 0
+ */
 #define CFS_FAIL_CHECK_RESET(id, value) \
        cfs_fail_check_set(id, value, CFS_FAIL_LOC_RESET, 0)
 #define CFS_FAIL_CHECK_RESET_QUIET(id, value) \
@@ -138,8 +144,10 @@ static inline int cfs_fail_timeout_set(__u32 id, __u32 value, int ms, int set)
 #define CFS_FAIL_TIMEOUT_MS(id, ms) \
        cfs_fail_timeout_set(id, 0, ms, CFS_FAIL_LOC_NOSET)
 
-/* If id hit cfs_fail_loc, cfs_fail_loc |= value and
- * sleep seconds or milliseconds */
+/*
+ * If id hit cfs_fail_loc, cfs_fail_loc |= value and
+ * sleep seconds or milliseconds
+ */
 #define CFS_FAIL_TIMEOUT_ORSET(id, value, secs) \
        cfs_fail_timeout_set(id, value, secs * 1000, CFS_FAIL_LOC_ORSET)
 
@@ -152,10 +160,12 @@ static inline int cfs_fail_timeout_set(__u32 id, __u32 value, int ms, int set)
 #define CFS_FAULT_CHECK(id)                    \
        CFS_FAIL_CHECK(CFS_FAULT | (id))
 
-/* The idea here is to synchronise two threads to force a race. The
+/*
+ * The idea here is to synchronise two threads to force a race. The
  * first thread that calls this with a matching fail_loc is put to
  * sleep. The next thread that calls with the same fail_loc wakes up
- * the first and continues. */
+ * the first and continues.
+ */
 static inline void cfs_race(__u32 id)
 {
 
index f2b43996213f8242526798243bb7b6fc61e26804..a4ca4882d4524fca977c9fa039adfd6ac62404f2 100644 (file)
 
 /** disable debug */
 #define CFS_HASH_DEBUG_NONE    0
-/** record hash depth and output to console when it's too deep,
- *  computing overhead is low but consume more memory */
+/*
+ * record hash depth and output to console when it's too deep,
+ * computing overhead is low but consume more memory
+ */
 #define CFS_HASH_DEBUG_1       1
 /** expensive, check key validation */
 #define CFS_HASH_DEBUG_2       2
@@ -153,8 +155,10 @@ enum cfs_hash_tag {
         * change on hash table is non-blocking
         */
        CFS_HASH_NBLK_CHANGE    = 1 << 13,
-       /** NB, we typed hs_flags as  __u16, please change it
-        * if you need to extend >=16 flags */
+       /**
+        * NB, we typed hs_flags as  __u16, please change it
+        * if you need to extend >=16 flags
+        */
 };
 
 /** most used attributes */
@@ -201,8 +205,10 @@ enum cfs_hash_tag {
  */
 
 struct cfs_hash {
-       /** serialize with rehash, or serialize all operations if
-        * the hash-table has CFS_HASH_NO_BKTLOCK */
+       /**
+        * serialize with rehash, or serialize all operations if
+        * the hash-table has CFS_HASH_NO_BKTLOCK
+        */
        union cfs_hash_lock             hs_lock;
        /** hash operations */
        struct cfs_hash_ops             *hs_ops;
@@ -369,9 +375,11 @@ cfs_hash_with_add_tail(struct cfs_hash *hs)
 static inline int
 cfs_hash_with_no_itemref(struct cfs_hash *hs)
 {
-       /* hash-table doesn't keep refcount on item,
+       /*
+        * hash-table doesn't keep refcount on item,
         * item can't be removed from hash unless it's
-        * ZERO refcount */
+        * ZERO refcount
+        */
        return (hs->hs_flags & CFS_HASH_NO_ITEMREF) != 0;
 }
 
index e0e1a5d0949d8f09e069f54e2fa5a182e8634db3..523e8f4463170550a4730cedd70c035163b6a7ba 100644 (file)
@@ -280,7 +280,7 @@ do {                                                            \
 #define CFS_FREE_PTR(ptr)       LIBCFS_FREE(ptr, sizeof(*(ptr)))
 
 /** Compile-time assertion.
-
+ *
  * Check an invariant described by a constant expression at compile time by
  * forcing a compiler error if it does not hold.  \a cond must be a constant
  * expression as defined by the ISO C Standard:
@@ -306,7 +306,8 @@ do {                                                            \
 /* --------------------------------------------------------------------
  * Light-weight trace
  * Support for temporary event tracing with minimal Heisenberg effect.
- * -------------------------------------------------------------------- */
+ * --------------------------------------------------------------------
+ */
 
 #define MKSTR(ptr) ((ptr)) ? (ptr) : ""
 
index 0ee60ff336f2dada891bb7750b5d96c36112c046..56341d9c2528e02677560cbb5e591d1ac97a6834 100644 (file)
@@ -84,9 +84,11 @@ int cfs_expr_list_values(struct cfs_expr_list *expr_list,
 static inline void
 cfs_expr_list_values_free(__u32 *values, int num)
 {
-       /* This array is allocated by LIBCFS_ALLOC(), so it shouldn't be freed
+       /*
+        * This array is allocated by LIBCFS_ALLOC(), so it shouldn't be freed
         * by OBD_FREE() if it's called by module other than libcfs & LNet,
-        * otherwise we will see fake memory leak */
+        * otherwise we will see fake memory leak
+        */
        LIBCFS_FREE(values, num * sizeof(values[0]));
 }