]> git.karo-electronics.de Git - karo-tx-linux.git/commitdiff
cpumask: fix kernel-doc incompatible comments
authorAlex Shi <alex.shi@intel.com>
Sat, 21 Jul 2012 22:28:15 +0000 (08:28 +1000)
committerStephen Rothwell <sfr@canb.auug.org.au>
Sat, 21 Jul 2012 22:28:15 +0000 (08:28 +1000)
commit c4549cd0d77 introduced some kernel-doc incompatible comments
format, that make kernel-doc output mess and looks strange. like
the part of man cpumask_subset, the DESCRIPTION part merged into
ARGUMENTS incorrectly:

ARGUMENTS
       src1p       the first input

       src2p       the second input Returns 1 if *src1p is a subset of *src2p, else returns 0

Signed-off-by: Alex Shi <alex.shi@intel.com>
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
include/linux/cpumask.h

index 170c5afa2ac8f7c551d94cb4ce87f812b32f50a6..8bf1c275fce348f07bf988fc4b678c636f3cf402 100644 (file)
@@ -271,7 +271,8 @@ static inline void cpumask_clear_cpu(int cpu, struct cpumask *dstp)
  * cpumask_test_cpu - test for a cpu in a cpumask
  * @cpu: cpu number (< nr_cpu_ids)
  * @cpumask: the cpumask pointer
- * Returns 1 if 'cpu' is set in 'cpumask', else returns 0
+ *
+ * Returns 1 if @cpu is set in @cpumask, else returns 0
  *
  * No static inline type checking - see Subtlety (1) above.
  */
@@ -282,7 +283,8 @@ static inline void cpumask_clear_cpu(int cpu, struct cpumask *dstp)
  * cpumask_test_and_set_cpu - atomically test and set a cpu in a cpumask
  * @cpu: cpu number (< nr_cpu_ids)
  * @cpumask: the cpumask pointer
- * Returns 1 if 'cpu' is set in old bitmap of 'cpumask', else returns 0
+ *
+ * Returns 1 if @cpu is set in old bitmap of @cpumask, else returns 0
  *
  * test_and_set_bit wrapper for cpumasks.
  */
@@ -295,7 +297,8 @@ static inline int cpumask_test_and_set_cpu(int cpu, struct cpumask *cpumask)
  * cpumask_test_and_clear_cpu - atomically test and clear a cpu in a cpumask
  * @cpu: cpu number (< nr_cpu_ids)
  * @cpumask: the cpumask pointer
- * Returns 1 if 'cpu' is set in old bitmap of 'cpumask', else returns 0
+ *
+ * Returns 1 if @cpu is set in old bitmap of @cpumask, else returns 0
  *
  * test_and_clear_bit wrapper for cpumasks.
  */
@@ -327,7 +330,8 @@ static inline void cpumask_clear(struct cpumask *dstp)
  * @dstp: the cpumask result
  * @src1p: the first input
  * @src2p: the second input
- * If *dstp is empty, returns 0, else returns 1
+ *
+ * If *@dstp is empty, returns 0, else returns 1
  */
 static inline int cpumask_and(struct cpumask *dstp,
                               const struct cpumask *src1p,
@@ -369,7 +373,8 @@ static inline void cpumask_xor(struct cpumask *dstp,
  * @dstp: the cpumask result
  * @src1p: the first input
  * @src2p: the second input
- * If *dstp is empty, returns 0, else returns 1
+ *
+ * If *@dstp is empty, returns 0, else returns 1
  */
 static inline int cpumask_andnot(struct cpumask *dstp,
                                  const struct cpumask *src1p,
@@ -419,7 +424,8 @@ static inline bool cpumask_intersects(const struct cpumask *src1p,
  * cpumask_subset - (*src1p & ~*src2p) == 0
  * @src1p: the first input
  * @src2p: the second input
- * Returns 1 if *src1p is a subset of *src2p, else returns 0
+ *
+ * Returns 1 if *@src1p is a subset of *@src2p, else returns 0
  */
 static inline int cpumask_subset(const struct cpumask *src1p,
                                 const struct cpumask *src2p)