Commit 6ffd853b authored Mar 01, 2026 by Randy Dunlap Committed by Andrew Morton Mar 10, 2026

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>

parent 36f46b0e

include/linux/build_bug.h

+3 −1

Original line number	Diff line number	Diff line
		@@ -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