]> git.ipfire.org Git - thirdparty/kernel/stable.git/commitdiff
build_bug.h: correct function parameters names in kernel-doc
authorRandy Dunlap <rdunlap@infradead.org>
Mon, 2 Mar 2026 00:51:44 +0000 (16:51 -0800)
committerAndrew Morton <akpm@linux-foundation.org>
Tue, 10 Mar 2026 23:01:48 +0000 (16:01 -0700)
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>
include/linux/build_bug.h

index 2cfbb4c65c784ad82edd1e45c1b4f4c23e78b009..d3dc5dc5f916ff4ecc2db640b253d2e6cdccb373 100644 (file)
@@ -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