]> git.ipfire.org Git - thirdparty/kernel/linux.git/commitdiff
util_macros.h: fix the reference in kernel-doc
authorAndy Shevchenko <andriy.shevchenko@linux.intel.com>
Mon, 28 Apr 2025 07:27:37 +0000 (10:27 +0300)
committerAndrew Morton <akpm@linux-foundation.org>
Mon, 12 May 2025 00:54:12 +0000 (17:54 -0700)
In PTR_IF() description the text refers to the parameter as (ptr) while
the kernel-doc format asks for @ptr.  Fix this accordingly.

Link: https://lkml.kernel.org/r/20250428072737.3265239-1-andriy.shevchenko@linux.intel.com
Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
Cc: Alexandru Ardelean <aardelean@baylibre.com>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
include/linux/util_macros.h

index 7b64fb597f85dd04168e9e436e0524b2c5e0869a..8183ac610cc5530d9211b6e5c3371cb0d545fdbc 100644 (file)
@@ -85,7 +85,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.
  *