Skip to content

Commit 6ffd853

Browse files
rddunlapakpm00
authored andcommitted
build_bug.h: correct function parameters names in kernel-doc
Use the correct function (or macro) names to avoid kernel-doc warnings: Warning: include/linux/build_bug.h:38 function parameter 'cond' not described in 'BUILD_BUG_ON_MSG' Warning: include/linux/build_bug.h:38 function parameter 'msg' not described in 'BUILD_BUG_ON_MSG' Warning: include/linux/build_bug.h:76 function parameter 'expr' not described in 'static_assert' Link: https://lkml.kernel.org/r/20260302005144.3467019-1-rdunlap@infradead.org Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Reviewed-by: SeongJae Park <sj@kernel.org> Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
1 parent 36f46b0 commit 6ffd853

1 file changed

Lines changed: 3 additions & 1 deletion

File tree

include/linux/build_bug.h

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,8 @@
3232
/**
3333
* BUILD_BUG_ON_MSG - break compile if a condition is true & emit supplied
3434
* error message.
35-
* @condition: the condition which the compiler should know is false.
35+
* @cond: the condition which the compiler should know is false.
36+
* @msg: build-time error message
3637
*
3738
* See BUILD_BUG_ON for description.
3839
*/
@@ -60,6 +61,7 @@
6061

6162
/**
6263
* static_assert - check integer constant expression at build time
64+
* @expr: expression to be checked
6365
*
6466
* static_assert() is a wrapper for the C11 _Static_assert, with a
6567
* little macro magic to make the message optional (defaulting to the

0 commit comments

Comments
 (0)