Thread (3 messages) 3 messages, 3 authors, 2021-05-26

Re: [PATCH] ipac: ipoctal: fix kernel-doc syntax and remove filename from file headers

From: Samuel Iglesias Gonsálvez <hidden>
Date: 2021-05-26 10:36:03
Also in: linux-kernel-mentees, lkml

Acked-by: Samuel Iglesias Gonsalvez <redacted>

Thanks,

Sam

On Sat, 2021-05-22 at 17:49 +0530, Aditya Srivastava wrote:
quoted hunk ↗ jump to hunk
The opening comment mark '/**' is used for highlighting the beginning
of
kernel-doc comments.
The header for drivers/ipack/devices/ipoctal follows this syntax, but
the
content inside does not comply with kernel-doc.

This line was probably not meant for kernel-doc parsing, but is
parsed
due to the presence of kernel-doc like comment syntax(i.e, '/**'),
which
causes unexpected warning from kernel-doc.

For e.g., running scripts/kernel-doc -none on
drivers/ipack/devices/ipoctal.h emits:
warning: This comment starts with '/**', but isn't a kernel-doc
comment. Refer Documentation/doc-guide/kernel-doc.rst
 * ipoctal.h

Provide a simple fix by replacing this occurrence with general
comment
format, i.e. '/*', to prevent kernel-doc from parsing it.

Also remove the redundant file name from the comment headers.

Signed-off-by: Aditya Srivastava <redacted>
---
 drivers/ipack/devices/ipoctal.c | 4 +---
 drivers/ipack/devices/ipoctal.h | 6 ++----
 2 files changed, 3 insertions(+), 7 deletions(-)
diff --git a/drivers/ipack/devices/ipoctal.c
b/drivers/ipack/devices/ipoctal.c
index 3940714e4397..2a3a94f72dfb 100644
--- a/drivers/ipack/devices/ipoctal.c
+++ b/drivers/ipack/devices/ipoctal.c
@@ -1,7 +1,5 @@
 // SPDX-License-Identifier: GPL-2.0-only
-/**
- * ipoctal.c
- *
+/*
  * driver for the GE IP-OCTAL boards
  *
  * Copyright (C) 2009-2012 CERN (www.cern.ch)
diff --git a/drivers/ipack/devices/ipoctal.h
b/drivers/ipack/devices/ipoctal.h
index 75f83ba774a4..773dc41bd667 100644
--- a/drivers/ipack/devices/ipoctal.h
+++ b/drivers/ipack/devices/ipoctal.h
@@ -1,9 +1,7 @@
 /* SPDX-License-Identifier: GPL-2.0-only */
-/**
- * ipoctal.h
- *
+/*
  * driver for the IPOCTAL boards
-
+ *
  * Copyright (C) 2009-2012 CERN (www.cern.ch)
  * Author: Nicolas Serafini, EIC2 SA
  * Author: Samuel Iglesias Gonsalvez [off-list ref]
  

Attachments

Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help