| From: Andy Shevchenko <andriy.shevchenko@linux.intel.com> |
| Subject: util_macros.h: fix the reference in kernel-doc |
| Date: Mon, 28 Apr 2025 10:27:37 +0300 |
| |
| 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 | 2 +- |
| 1 file changed, 1 insertion(+), 1 deletion(-) |
| |
| --- a/include/linux/util_macros.h~util_macrosh-fix-the-reference-in-kernel-doc |
| +++ a/include/linux/util_macros.h |
| @@ -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. |
| * |
| _ |
