Skip to content

Commit fa47906

Browse files
committed
vsnprintf: fix up kerneldoc for argument name changes
Stephen Rothwell reports that I missed fixing up the documentation when the argument names changed in commit 938df69 ("vsprintf: associate the format state with the format pointer"), resulting in htmldoc warnings like lib/vsprintf.c:2760: warning: Function parameter or struct member 'fmt_str' not described in 'vsnprintf' lib/vsprintf.c:2760: warning: Excess function parameter 'fmt' description in 'vsnprintf' ... which I didn't notice because the doc build takes longer than the whole "real" kernel build for me, so I never bother (and judging by the other warnings, pretty much nobody else does either). I guess the bigger issues won't be fixed until the doc build is much faster (narrator: "That isn's in the cards") but at least linux-next finds the new cases. Reported-by: Stephen Rothwell <[email protected]> Fixes: 938df69 ("vsprintf: associate the format state with the format pointer") Signed-off-by: Linus Torvalds <[email protected]>
1 parent 4c53804 commit fa47906

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

lib/vsprintf.c

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2732,7 +2732,7 @@ static unsigned long long convert_num_spec(unsigned int val, int size, struct pr
27322732
* vsnprintf - Format a string and place it in a buffer
27332733
* @buf: The buffer to place the result into
27342734
* @size: The size of the buffer, including the trailing null space
2735-
* @fmt: The format string to use
2735+
* @fmt_str: The format string to use
27362736
* @args: Arguments for the format string
27372737
*
27382738
* This function generally follows C99 vsnprintf, but has some
@@ -3020,7 +3020,7 @@ EXPORT_SYMBOL(sprintf);
30203020
* vbin_printf - Parse a format string and place args' binary value in a buffer
30213021
* @bin_buf: The buffer to place args' binary value
30223022
* @size: The size of the buffer(by words(32bits), not characters)
3023-
* @fmt: The format string to use
3023+
* @fmt_str: The format string to use
30243024
* @args: Arguments for the format string
30253025
*
30263026
* The format follows C99 vsnprintf, except %n is ignored, and its argument
@@ -3155,7 +3155,7 @@ EXPORT_SYMBOL_GPL(vbin_printf);
31553155
* bstr_printf - Format a string from binary arguments and place it in a buffer
31563156
* @buf: The buffer to place the result into
31573157
* @size: The size of the buffer, including the trailing null space
3158-
* @fmt: The format string to use
3158+
* @fmt_str: The format string to use
31593159
* @bin_buf: Binary arguments for the format string
31603160
*
31613161
* This function like C99 vsnprintf, but the difference is that vsnprintf gets

0 commit comments

Comments
 (0)