linux-kernel - [PATCH v1 1/1] util_macros.h: Fix the reference in kernel-doc

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [day] [month] [year] [list]

Message-ID: <20250428072715.3265168-1-andriy.shevchenko@linux.intel.com>
Date: Mon, 28 Apr 2025 10:27:15 +0300
From: Andy Shevchenko <andriy.shevchenko@...ux.intel.com>
To: Andy Shevchenko <andriy.shevchenko@...ux.intel.com>,
	Alexandru Ardelean <aardelean@...libre.com>,
	linux-kernel@...r.kernel.org
Subject: [PATCH v1 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.

Signed-off-by: Andy Shevchenko <andriy.shevchenko@...ux.intel.com>
---
 include/linux/util_macros.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/include/linux/util_macros.h b/include/linux/util_macros.h
index 93b30c1dce60..dcb836ef0cc3 100644
--- a/include/linux/util_macros.h
+++ b/include/linux/util_macros.h
@@ -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.
  *
-- 
2.47.2