mirror of
https://github.com/tbsdtv/linux_media.git
synced 2025-07-23 20:51:03 +02:00
lib: bitmap: fix many kernel-doc warnings
Fix kernel-doc warings in lib/bitmap.c: lib/bitmap.c:498: warning: Function parameter or member 'buf' not described in 'bitmap_print_to_buf' lib/bitmap.c:498: warning: Function parameter or member 'maskp' not described in 'bitmap_print_to_buf' lib/bitmap.c:498: warning: Function parameter or member 'nmaskbits' not described in 'bitmap_print_to_buf' lib/bitmap.c:498: warning: Function parameter or member 'off' not described in 'bitmap_print_to_buf' lib/bitmap.c:498: warning: Function parameter or member 'count' not described in 'bitmap_print_to_buf' lib/bitmap.c:561: warning: contents before sections lib/bitmap.c:606: warning: Function parameter or member 'buf' not described in 'bitmap_print_list_to_buf' lib/bitmap.c:606: warning: Function parameter or member 'maskp' not described in 'bitmap_print_list_to_buf' lib/bitmap.c:606: warning: Function parameter or member 'nmaskbits' not described in 'bitmap_print_list_to_buf' lib/bitmap.c:606: warning: Function parameter or member 'off' not described in 'bitmap_print_list_to_buf' lib/bitmap.c:606: warning: Function parameter or member 'count' not described in 'bitmap_print_list_to_buf' lib/bitmap.c:819: warning: missing initial short description on line: * bitmap_parselist_user() This still leaves 15 warnings for function return values not described, similar to this one: bitmap.c:890: warning: No description found for return value of 'bitmap_parse' Link: https://lkml.kernel.org/r/20220306065823.5153-1-rdunlap@infradead.org Fixes:1fae562983
("cpumask: introduce cpumap_print_list/bitmask_to_buf to support large bitmask and list") Fixes:4b060420a5
("bitmap, irq: add smp_affinity_list interface to /proc/irq") Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Cc: Yury Norov <yury.norov@gmail.com> Cc: Andy Shevchenko <andriy.shevchenko@linux.intel.com> Cc: Rasmus Villemoes <linux@rasmusvillemoes.dk> Cc: Tian Tao <tiantao6@hisilicon.com> Cc: Mike Travis <mike.travis@hpe.com> Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org> Signed-off-by: Andrew Morton <akpm@linux-foundation.org> Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
This commit is contained in:
committed by
Linus Torvalds
parent
1bf18da621
commit
2699e5143c
24
lib/bitmap.c
24
lib/bitmap.c
@@ -492,6 +492,11 @@ EXPORT_SYMBOL(bitmap_print_to_pagebuf);
|
|||||||
* @list: indicates whether the bitmap must be list
|
* @list: indicates whether the bitmap must be list
|
||||||
* true: print in decimal list format
|
* true: print in decimal list format
|
||||||
* false: print in hexadecimal bitmask format
|
* false: print in hexadecimal bitmask format
|
||||||
|
* @buf: buffer into which string is placed
|
||||||
|
* @maskp: pointer to bitmap to convert
|
||||||
|
* @nmaskbits: size of bitmap, in bits
|
||||||
|
* @off: in the string from which we are copying, We copy to @buf
|
||||||
|
* @count: the maximum number of bytes to print
|
||||||
*/
|
*/
|
||||||
static int bitmap_print_to_buf(bool list, char *buf, const unsigned long *maskp,
|
static int bitmap_print_to_buf(bool list, char *buf, const unsigned long *maskp,
|
||||||
int nmaskbits, loff_t off, size_t count)
|
int nmaskbits, loff_t off, size_t count)
|
||||||
@@ -512,6 +517,11 @@ static int bitmap_print_to_buf(bool list, char *buf, const unsigned long *maskp,
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* bitmap_print_bitmask_to_buf - convert bitmap to hex bitmask format ASCII string
|
* bitmap_print_bitmask_to_buf - convert bitmap to hex bitmask format ASCII string
|
||||||
|
* @buf: buffer into which string is placed
|
||||||
|
* @maskp: pointer to bitmap to convert
|
||||||
|
* @nmaskbits: size of bitmap, in bits
|
||||||
|
* @off: in the string from which we are copying, We copy to @buf
|
||||||
|
* @count: the maximum number of bytes to print
|
||||||
*
|
*
|
||||||
* The bitmap_print_to_pagebuf() is used indirectly via its cpumap wrapper
|
* The bitmap_print_to_pagebuf() is used indirectly via its cpumap wrapper
|
||||||
* cpumap_print_to_pagebuf() or directly by drivers to export hexadecimal
|
* cpumap_print_to_pagebuf() or directly by drivers to export hexadecimal
|
||||||
@@ -553,12 +563,6 @@ static int bitmap_print_to_buf(bool list, char *buf, const unsigned long *maskp,
|
|||||||
* move to use bin_attribute. In result, we have to pass the corresponding
|
* move to use bin_attribute. In result, we have to pass the corresponding
|
||||||
* parameters such as off, count from bin_attribute show entry to this API.
|
* parameters such as off, count from bin_attribute show entry to this API.
|
||||||
*
|
*
|
||||||
* @buf: buffer into which string is placed
|
|
||||||
* @maskp: pointer to bitmap to convert
|
|
||||||
* @nmaskbits: size of bitmap, in bits
|
|
||||||
* @off: in the string from which we are copying, We copy to @buf
|
|
||||||
* @count: the maximum number of bytes to print
|
|
||||||
*
|
|
||||||
* The role of cpumap_print_bitmask_to_buf() and cpumap_print_list_to_buf()
|
* The role of cpumap_print_bitmask_to_buf() and cpumap_print_list_to_buf()
|
||||||
* is similar with cpumap_print_to_pagebuf(), the difference is that
|
* is similar with cpumap_print_to_pagebuf(), the difference is that
|
||||||
* bitmap_print_to_pagebuf() mainly serves sysfs attribute with the assumption
|
* bitmap_print_to_pagebuf() mainly serves sysfs attribute with the assumption
|
||||||
@@ -597,6 +601,11 @@ EXPORT_SYMBOL(bitmap_print_bitmask_to_buf);
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* bitmap_print_list_to_buf - convert bitmap to decimal list format ASCII string
|
* bitmap_print_list_to_buf - convert bitmap to decimal list format ASCII string
|
||||||
|
* @buf: buffer into which string is placed
|
||||||
|
* @maskp: pointer to bitmap to convert
|
||||||
|
* @nmaskbits: size of bitmap, in bits
|
||||||
|
* @off: in the string from which we are copying, We copy to @buf
|
||||||
|
* @count: the maximum number of bytes to print
|
||||||
*
|
*
|
||||||
* Everything is same with the above bitmap_print_bitmask_to_buf() except
|
* Everything is same with the above bitmap_print_bitmask_to_buf() except
|
||||||
* the print format.
|
* the print format.
|
||||||
@@ -807,7 +816,8 @@ EXPORT_SYMBOL(bitmap_parselist);
|
|||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* bitmap_parselist_user()
|
* bitmap_parselist_user() - convert user buffer's list format ASCII
|
||||||
|
* string to bitmap
|
||||||
*
|
*
|
||||||
* @ubuf: pointer to user buffer containing string.
|
* @ubuf: pointer to user buffer containing string.
|
||||||
* @ulen: buffer size in bytes. If string is smaller than this
|
* @ulen: buffer size in bytes. If string is smaller than this
|
||||||
|
Reference in New Issue
Block a user