Commit 9a86e2bad0b9fbf3290ae496da6dab9536dd6bf7

Authored by Ben Hutchings
Committed by Linus Torvalds
1 parent a069c266ae

lib: fix first line of kernel-doc for a few functions

The function name must be followed by a space, hypen, space, and a short
description.

Signed-off-by: Ben Hutchings <ben@decadent.org.uk>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>

Showing 2 changed files with 6 additions and 6 deletions Side-by-side Diff

include/linux/list.h
... ... @@ -498,7 +498,7 @@
498 498 pos = n, n = list_entry(n->member.next, typeof(*n), member))
499 499  
500 500 /**
501   - * list_for_each_entry_safe_continue
  501 + * list_for_each_entry_safe_continue - continue list iteration safe against removal
502 502 * @pos: the type * to use as a loop cursor.
503 503 * @n: another type * to use as temporary storage
504 504 * @head: the head for your list.
... ... @@ -514,7 +514,7 @@
514 514 pos = n, n = list_entry(n->member.next, typeof(*n), member))
515 515  
516 516 /**
517   - * list_for_each_entry_safe_from
  517 + * list_for_each_entry_safe_from - iterate over list from current point safe against removal
518 518 * @pos: the type * to use as a loop cursor.
519 519 * @n: another type * to use as temporary storage
520 520 * @head: the head for your list.
... ... @@ -529,7 +529,7 @@
529 529 pos = n, n = list_entry(n->member.next, typeof(*n), member))
530 530  
531 531 /**
532   - * list_for_each_entry_safe_reverse
  532 + * list_for_each_entry_safe_reverse - iterate backwards over list safe against removal
533 533 * @pos: the type * to use as a loop cursor.
534 534 * @n: another type * to use as temporary storage
535 535 * @head: the head for your list.
... ... @@ -487,7 +487,7 @@
487 487 EXPORT_SYMBOL(__bitmap_parse);
488 488  
489 489 /**
490   - * bitmap_parse_user()
  490 + * bitmap_parse_user - convert an ASCII hex string in a user buffer into a bitmap
491 491 *
492 492 * @ubuf: pointer to user buffer containing string.
493 493 * @ulen: buffer size in bytes. If string is smaller than this
... ... @@ -619,7 +619,7 @@
619 619 EXPORT_SYMBOL(bitmap_parselist);
620 620  
621 621 /**
622   - * bitmap_pos_to_ord(buf, pos, bits)
  622 + * bitmap_pos_to_ord - find ordinal of set bit at given position in bitmap
623 623 * @buf: pointer to a bitmap
624 624 * @pos: a bit position in @buf (0 <= @pos < @bits)
625 625 * @bits: number of valid bit positions in @buf
... ... @@ -655,7 +655,7 @@
655 655 }
656 656  
657 657 /**
658   - * bitmap_ord_to_pos(buf, ord, bits)
  658 + * bitmap_ord_to_pos - find position of n-th set bit in bitmap
659 659 * @buf: pointer to bitmap
660 660 * @ord: ordinal bit position (n-th set bit, n >= 0)
661 661 * @bits: number of valid bit positions in @buf