[PATCH] build_bug.h: correct function parameters names in kernel-doc

[PATCH] build_bug.h: correct function parameters names in kernel-doc

[Randy Dunlap]

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'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
Cc: Andrew Morton <akpm@linux-foundation.org>

 include/linux/build_bug.h |    4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

--- linux-next-20260227.orig/include/linux/build_bug.h
+++ linux-next-20260227/include/linux/build_bug.h
@@ -32,7 +32,8 @@
 /**
  * BUILD_BUG_ON_MSG - break compile if a condition is true & emit supplied
  *		      error message.
- * @condition: the condition which the compiler should know is false.
+ * @cond: the condition which the compiler should know is false.
+ * @msg: build-time error message
  *
  * See BUILD_BUG_ON for description.
  */
@@ -60,6 +61,7 @@
 
 /**
  * static_assert - check integer constant expression at build time
+ * @expr: expression to be checked
  *
  * static_assert() is a wrapper for the C11 _Static_assert, with a
  * little macro magic to make the message optional (defaulting to the

Re: [PATCH] build_bug.h: correct function parameters names in kernel-doc

[SeongJae Park]

On Sun,  1 Mar 2026 16:51:44 -0800 Randy Dunlap <rdunlap@infradead.org> wrote:

> 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'
> 
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>

Reviewed-by: SeongJae Park <sj@kernel.org>


Thanks,
SJ

[...]