Skip to contentSkip to conversation

util_macros.h: Fix the reference in kernel-doc

PATCH Superseded Andy Shevchenko 1 participant 1 message Apr 28, 2025

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 util_macros.h: Fix the reference in kernel-doc

In PTR_IF() description the text refers to the parameter as (ptr) while the kernel-doc format asks for @ptr. Fix this accordingly.

---
 include/linux/util_macros.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
include/linux/util_macros.h +1 -1
index 93b30c1dce60..dcb836ef0cc3 100644
@@ -88,7 +88,7 @@
  * @ptr: A pointer to assign if @cond is true.
  *
  * PTR_IF(IS_ENABLED(CONFIG_FOO), ptr) evaluates to @ptr if CONFIG_FOO is set
- * to 'y' or 'm', or to NULL otherwise. The (ptr) argument must be a pointer.
+ * to 'y' or 'm', or to NULL otherwise. The @ptr argument must be a pointer.
  *
  * The macro can be very useful to help compiler dropping dead code.
  *
Signature · 1 line
2.47.2