linux-kernel - [PATCH] lib/iomem_copy: fix kerneldoc format style

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: <20241029075038.645336-1-arnd@kernel.org>
Date: Tue, 29 Oct 2024 07:50:33 +0000
From: Arnd Bergmann <arnd@...nel.org>
To: linux-kernel@...r.kernel.org
Cc: Arnd Bergmann <arnd@...db.de>,
	kernel test robot <lkp@...el.com>,
	Andrew Morton <akpm@...ux-foundation.org>,
	Yann Sionneau <ysionneau@...rayinc.com>,
	Julian Vetter <jvetter@...rayinc.com>
Subject: [PATCH] lib/iomem_copy: fix kerneldoc format style

From: Arnd Bergmann <arnd@...db.de>

The newly added file did not quite get the punctuation right:

lib/iomem_copy.c:14: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst

Reported-by: kernel test robot <lkp@...el.com>
Closes: https://lore.kernel.org/oe-kbuild-all/202410290907.0mDZVYPK-lkp@intel.com/
Signed-off-by: Arnd Bergmann <arnd@...db.de>
---
I've applied this on top of the series that introduced the warning.

 lib/iomem_copy.c | 24 ++++++++++++------------
 1 file changed, 12 insertions(+), 12 deletions(-)

diff --git a/lib/iomem_copy.c b/lib/iomem_copy.c
index 24c2b59a0ad2..dec7eaea60e0 100644
--- a/lib/iomem_copy.c
+++ b/lib/iomem_copy.c
@@ -11,10 +11,10 @@
 
 #ifndef memset_io
 /**
- * memset_io		Set a range of I/O memory to a constant value
- * @addr:		The beginning of the I/O-memory range to set
- * @val:		The value to set the memory to
- * @count:		The number of bytes to set
+ * memset_io() - Set a range of I/O memory to a constant value
+ * @addr: The beginning of the I/O-memory range to set
+ * @val: The value to set the memory to
+ * @count: The number of bytes to set
  *
  * Set a range of I/O memory to a given value.
  */
@@ -52,10 +52,10 @@ EXPORT_SYMBOL(memset_io);
 
 #ifndef memcpy_fromio
 /**
- * memcpy_fromio	Copy a block of data from I/O memory
- * @dst:		The (RAM) destination for the copy
- * @src:		The (I/O memory) source for the data
- * @count:		The number of bytes to copy
+ * memcpy_fromio() - Copy a block of data from I/O memory
+ * @dst: The (RAM) destination for the copy
+ * @src: The (I/O memory) source for the data
+ * @count: The number of bytes to copy
  *
  * Copy a block of data from I/O memory.
  */
@@ -94,10 +94,10 @@ EXPORT_SYMBOL(memcpy_fromio);
 
 #ifndef memcpy_toio
 /**
- * memcpy_toio		Copy a block of data into I/O memory
- * @dst:		The (I/O memory) destination for the copy
- * @src:		The (RAM) source for the data
- * @count:		The number of bytes to copy
+ * memcpy_toio() -Copy a block of data into I/O memory
+ * @dst: The (I/O memory) destination for the copy
+ * @src: The (RAM) source for the data
+ * @count: The number of bytes to copy
  *
  * Copy a block of data to I/O memory.
  */
-- 
2.39.5