Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 72fd4a35 authored by Robert P. J. Day's avatar Robert P. J. Day Committed by Linus Torvalds
Browse files

[PATCH] Numerous fixes to kernel-doc info in source files. 



A variety of (mostly) innocuous fixes to the embedded kernel-doc content in
source files, including:

  * make multi-line initial descriptions single line
  * denote some function names, constants and structs as such
  * change erroneous opening '/*' to '/**' in a few places
  * reword some text for clarity

Signed-off-by: default avatarRobert P. J. Day <rpjday@mindspring.com>
Cc: "Randy.Dunlap" <rdunlap@xenotime.net>
Signed-off-by: default avatarAndrew Morton <akpm@linux-foundation.org>
Signed-off-by: default avatarLinus Torvalds <torvalds@linux-foundation.org>
parent 262086cf

include/asm-i386/atomic.h

+2 −2
Original line number Diff line number Diff line
@@ -211,12 +211,12 @@ static __inline__ int atomic_sub_return(int i, atomic_t *v) 
#define atomic_xchg(v, new) (xchg(&((v)->counter), new))



/**

 * atomic_add_unless - add unless the number is a given value

 * atomic_add_unless - add unless the number is already a given value

 * @v: pointer of type atomic_t

 * @a: the amount to add to v...

 * @u: ...unless v is equal to u.

 *

 * Atomically adds @a to @v, so long as it was not @u.

 * Atomically adds @a to @v, so long as @v was not already @u.

 * Returns non-zero if @v was not @u, and zero otherwise.

 */

#define atomic_add_unless(v, a, u)				\

include/asm-i386/bitops.h

+2 −2
Original line number Diff line number Diff line
@@ -371,7 +371,7 @@ static inline unsigned long ffz(unsigned long word) 
 *

 * This is defined the same way as

 * the libc and compiler builtin ffs routines, therefore

 * differs in spirit from the above ffz (man ffs).

 * differs in spirit from the above ffz() (man ffs).

 */

static inline int ffs(int x)

{
@@ -388,7 +388,7 @@ static inline int ffs(int x) 
 * fls - find last bit set

 * @x: the word to search

 *

 * This is defined the same way as ffs.

 * This is defined the same way as ffs().

 */

static inline int fls(int x)

{

include/linux/init.h

+1 −1
Original line number Diff line number Diff line
@@ -172,7 +172,7 @@ void __init parse_early_param(void); 
 * module_init() - driver initialization entry point

 * @x: function to be run at kernel boot time or module insertion

 * 

 * module_init() will either be called during do_initcalls (if

 * module_init() will either be called during do_initcalls() (if

 * builtin) or at module insertion time (if a module).  There can only

 * be one per module.

 */

include/linux/kfifo.h

+3 −3
Original line number Diff line number Diff line
@@ -74,7 +74,7 @@ static inline void kfifo_reset(struct kfifo *fifo) 
 * @buffer: the data to be added.

 * @len: the length of the data to be added.

 *

 * This function copies at most 'len' bytes from the 'buffer' into

 * This function copies at most @len bytes from the @buffer into

 * the FIFO depending on the free space, and returns the number of

 * bytes copied.

 */
@@ -99,8 +99,8 @@ static inline unsigned int kfifo_put(struct kfifo *fifo, 
 * @buffer: where the data must be copied.

 * @len: the size of the destination buffer.

 *

 * This function copies at most 'len' bytes from the FIFO into the

 * 'buffer' and returns the number of copied bytes.

 * This function copies at most @len bytes from the FIFO into the

 * @buffer and returns the number of copied bytes.

 */

static inline unsigned int kfifo_get(struct kfifo *fifo,

				     unsigned char *buffer, unsigned int len)

include/linux/ktime.h

+3 −3
Original line number Diff line number Diff line
@@ -163,7 +163,7 @@ static inline ktime_t ktime_sub(const ktime_t lhs, const ktime_t rhs) 
 * @add1:	addend1

 * @add2:	addend2

 *

 * Returns the sum of addend1 and addend2

 * Returns the sum of @add1 and @add2.

 */

static inline ktime_t ktime_add(const ktime_t add1, const ktime_t add2)

{
@@ -189,7 +189,7 @@ static inline ktime_t ktime_add(const ktime_t add1, const ktime_t add2) 
 * @kt:		addend

 * @nsec:	the scalar nsec value to add

 *

 * Returns the sum of kt and nsec in ktime_t format

 * Returns the sum of @kt and @nsec in ktime_t format

 */

extern ktime_t ktime_add_ns(const ktime_t kt, u64 nsec);
@@ -246,7 +246,7 @@ static inline struct timeval ktime_to_timeval(const ktime_t kt) 
 * ktime_to_ns - convert a ktime_t variable to scalar nanoseconds

 * @kt:		the ktime_t variable to convert

 *

 * Returns the scalar nanoseconds representation of kt

 * Returns the scalar nanoseconds representation of @kt

 */

static inline s64 ktime_to_ns(const ktime_t kt)

{