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

Commit 05a6c8a9 authored by Andrew Morton's avatar Andrew Morton Committed by Linus Torvalds
Browse files

lib/bitmap.c: fix documentation for scnprintf() functions 



The code comments for bscnl_emit() and bitmap_scnlistprintf() are
describing snprintf() return semantics, but these functions use
scnprintf() return semantics.  Fix that, and document the
bitmap_scnprintf() return value as well.

Cc: Ryota Ozaki <ozaki.ryota@gmail.com>
Signed-off-by: default avatarAndrew Morton <akpm@linux-foundation.org>
Signed-off-by: default avatarLinus Torvalds <torvalds@linux-foundation.org>
parent 68aecfb9

lib/bitmap.c

+6 −6
Original line number Diff line number Diff line
@@ -369,7 +369,8 @@ EXPORT_SYMBOL(bitmap_find_next_zero_area); 
 * @nmaskbits: size of bitmap, in bits

 *

 * Exactly @nmaskbits bits are displayed.  Hex digits are grouped into

 * comma-separated sets of eight digits per set.

 * comma-separated sets of eight digits per set.  Returns the number of

 * characters which were written to *buf, excluding the trailing \0.

 */

int bitmap_scnprintf(char *buf, unsigned int buflen,

	const unsigned long *maskp, int nmaskbits)
@@ -517,8 +518,8 @@ EXPORT_SYMBOL(bitmap_parse_user); 
 *

 * Helper routine for bitmap_scnlistprintf().  Write decimal number

 * or range to buf, suppressing output past buf+buflen, with optional

 * comma-prefix.  Return len of what would be written to buf, if it

 * all fit.

 * comma-prefix.  Return len of what was written to *buf, excluding the

 * trailing \0.

 */

static inline int bscnl_emit(char *buf, int buflen, int rbot, int rtop, int len)

{
@@ -544,9 +545,8 @@ static inline int bscnl_emit(char *buf, int buflen, int rbot, int rtop, int len) 
 * the range.  Output format is compatible with the format

 * accepted as input by bitmap_parselist().

 *

 * The return value is the number of characters which would be

 * generated for the given input, excluding the trailing '\0', as

 * per ISO C99.

 * The return value is the number of characters which were written to *buf

 * excluding the trailing '\0', as per ISO C99's scnprintf.

 */

int bitmap_scnlistprintf(char *buf, unsigned int buflen,

	const unsigned long *maskp, int nmaskbits)