Eric Lee / linux-smarc-t335x-v3.2

Download as
Browse Code ยป

Commit 6e1907ffdc694023712b5e6516933a29e1be954f

Authored by Randy Dunlap
Committed by Linus Torvalds
1 parent 099a71d995
Exists in master and in 4 other branches v3.2_AM335xPSP_04.06.00.11, v3.2_NEWT335xPSP_04.06.00.11, v3.2_SBC_SMARTMEN, v3.2_SMARCT335xPSP_04.06.00.11

[PATCH] kernel-doc for lib/bitmap.c 

Make corrections/fixes to kernel-doc in lib/bitmap.c and include it in DocBook
template.

Signed-off-by: Randy Dunlap <rdunlap@xenotime.net>
Signed-off-by: Andrew Morton <akpm@osdl.org>
Signed-off-by: Linus Torvalds <torvalds@osdl.org>

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

Documentation/DocBook/kernel-api.tmpl
Diff comments   View file @ 6e1907f
... ... @@ -112,6 +112,10 @@
112 112 <sect1><title>Bit Operations</title>
113 113 !Iinclude/asm-i386/bitops.h
114 114 </sect1>
  115 + <sect1><title>Bitmap Operations</title>
  116 +!Elib/bitmap.c
  117 +!Ilib/bitmap.c
  118 + </sect1>
115 119 </chapter>
116 120  
117 121 <chapter id="mm">
... ... @@ -317,16 +317,16 @@
317 317  
318 318 /**
319 319 * bitmap_parse - convert an ASCII hex string into a bitmap.
320   - * @buf: pointer to buffer in user space containing string.
321   - * @buflen: buffer size in bytes. If string is smaller than this
  320 + * @ubuf: pointer to buffer in user space containing string.
  321 + * @ubuflen: buffer size in bytes. If string is smaller than this
322 322 * then it must be terminated with a \0.
323 323 * @maskp: pointer to bitmap array that will contain result.
324 324 * @nmaskbits: size of bitmap, in bits.
325 325 *
326 326 * Commas group hex digits into chunks. Each chunk defines exactly 32
327 327 * bits of the resultant bitmask. No chunk may specify a value larger
328   - * than 32 bits (-EOVERFLOW), and if a chunk specifies a smaller value
329   - * then leading 0-bits are prepended. -EINVAL is returned for illegal
  328 + * than 32 bits (%-EOVERFLOW), and if a chunk specifies a smaller value
  329 + * then leading 0-bits are prepended. %-EINVAL is returned for illegal
330 330 * characters and for grouping errors such as "1,,5", ",44", "," and "".
331 331 * Leading and trailing whitespace accepted, but not embedded whitespace.
332 332 */
... ... @@ -452,8 +452,8 @@
452 452  
453 453 /**
454 454 * bitmap_parselist - convert list format ASCII string to bitmap
455   - * @buf: read nul-terminated user string from this buffer
456   - * @mask: write resulting mask here
  455 + * @bp: read nul-terminated user string from this buffer
  456 + * @maskp: write resulting mask here
457 457 * @nmaskbits: number of bits in mask to be written
458 458 *
459 459 * Input format is a comma-separated list of decimal numbers and
... ... @@ -461,10 +461,11 @@
461 461 * decimal numbers, the smallest and largest bit numbers set in
462 462 * the range.
463 463 *
464   - * Returns 0 on success, -errno on invalid input strings:
465   - * -EINVAL: second number in range smaller than first
466   - * -EINVAL: invalid character in string
467   - * -ERANGE: bit number specified too large for mask
  464 + * Returns 0 on success, -errno on invalid input strings.
  465 + * Error values:
  466 + * %-EINVAL: second number in range smaller than first
  467 + * %-EINVAL: invalid character in string
  468 + * %-ERANGE: bit number specified too large for mask
468 469 */
469 470 int bitmap_parselist(const char *bp, unsigned long *maskp, int nmaskbits)
470 471 {
... ... @@ -625,10 +626,10 @@
625 626  
626 627 /**
627 628 * bitmap_bitremap - Apply map defined by a pair of bitmaps to a single bit
628   - * @oldbit - bit position to be mapped
629   - * @old: defines domain of map
630   - * @new: defines range of map
631   - * @bits: number of bits in each of these bitmaps
  629 + * @oldbit: bit position to be mapped
  630 + * @old: defines domain of map
  631 + * @new: defines range of map
  632 + * @bits: number of bits in each of these bitmaps
632 633 *
633 634 * Let @old and @new define a mapping of bit positions, such that
634 635 * whatever position is held by the n-th set bit in @old is mapped
... ... @@ -790,7 +791,7 @@
790 791 *
791 792 * Allocate (set bits in) a specified region of a bitmap.
792 793 *
793   - * Return 0 on success, or -EBUSY if specified region wasn't
  794 + * Return 0 on success, or %-EBUSY if specified region wasn't
794 795 * free (not all bits were zero).
795 796 */
796 797 int bitmap_allocate_region(unsigned long *bitmap, int pos, int order)