Skip to contentSkip to conversation

ALSA: asihpi: fix comment syntax in file headers

PATCH In review Aditya Srivastava 3 participants 3 messages Mar 17, 2021 – Mar 18, 2021 Sound

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 ALSA: asihpi: fix comment syntax in file headers

The opening comment mark '/**' is used for highlighting the beginning of kernel-doc comments.
There are files in sound/pci/asihpi which follow this syntax in their file headers, i.e. start with '/**' like comments, which causes unexpected warnings from kernel-doc.

E.g., running scripts/kernel-doc -none on sound/pci/asihpi/hpidspcd.h causes this warning:
"warning: Cannot understand
on line 4 - I thought it was a doc line"

Provide a simple fix by replacing the kernel-doc like comment syntax with general format, i.e. "/*", to prevent kernel-doc from parsing it.

---
* Applies perfectly on next-20210312

 sound/pci/asihpi/hpicmn.h   | 2 +-
 sound/pci/asihpi/hpidspcd.h | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)
sound/pci/asihpi/hpicmn.h +1 -1
index de3bedd29d94..8ec656cf8848 100644
@@ -1,5 +1,5 @@
 /* SPDX-License-Identifier: GPL-2.0-only */
-/**
+/*
 
     AudioScience HPI driver
     Copyright (C) 1997-2014  AudioScience Inc. <[email protected]>
sound/pci/asihpi/hpidspcd.h +1 -1
index a01e8c6092bd..9f1468ed7096 100644
@@ -1,6 +1,6 @@
 /* SPDX-License-Identifier: GPL-2.0-only */
 /***********************************************************************/
-/**
+/*
 
     AudioScience HPI driver
     Copyright (C) 1997-2011  AudioScience Inc. <[email protected]>
Signature · 6 lines
2.17.1

_______________________________________________
Linux-kernel-mentees mailing list
[email protected]
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees
Acked-by on v1 1/1
#1 lore raw
Quoted 11 lines · Aditya Srivastava

The opening comment mark '/**' is used for highlighting the beginning of kernel-doc comments.
There are files in sound/pci/asihpi which follow this syntax in their file headers, i.e. start with '/**' like comments, which causes unexpected warnings from kernel-doc.

E.g., running scripts/kernel-doc -none on sound/pci/asihpi/hpidspcd.h causes this warning:
"warning: Cannot understand
on line 4 - I thought it was a doc line"

Quoted 4 lines

Provide a simple fix by replacing the kernel-doc like comment syntax with general format, i.e. "/*", to prevent kernel-doc from parsing it.

Thanks.

Quoted 31 lines

---
* Applies perfectly on next-20210312

 sound/pci/asihpi/hpicmn.h   | 2 +-
 sound/pci/asihpi/hpidspcd.h | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)
sound/pci/asihpi/hpicmn.h +1 -1
index de3bedd29d94..8ec656cf8848 100644
@@ -1,5 +1,5 @@
 /* SPDX-License-Identifier: GPL-2.0-only */
-/**
+/*
 
     AudioScience HPI driver
     Copyright (C) 1997-2014  AudioScience Inc. <[email protected]>
sound/pci/asihpi/hpidspcd.h +1 -1
index a01e8c6092bd..9f1468ed7096 100644
@@ -1,6 +1,6 @@
 /* SPDX-License-Identifier: GPL-2.0-only */
 /***********************************************************************/
-/**
+/*
 
     AudioScience HPI driver
     Copyright (C) 1997-2011  AudioScience Inc. <[email protected]>
Signature · 1 line
~Randy
#2 lore raw
In reply to Aditya Srivastava
Quoted 12 lines · Aditya Srivastava

The opening comment mark '/**' is used for highlighting the beginning of kernel-doc comments.
There are files in sound/pci/asihpi which follow this syntax in their file headers, i.e. start with '/**' like comments, which causes unexpected warnings from kernel-doc.

E.g., running scripts/kernel-doc -none on sound/pci/asihpi/hpidspcd.h causes this warning:
"warning: Cannot understand
on line 4 - I thought it was a doc line"

Quoted 4 lines

Provide a simple fix by replacing the kernel-doc like comment syntax with general format, i.e. "/*", to prevent kernel-doc from parsing it.

Applied now. Thanks.

Takashi
_______________________________________________
Linux-kernel-mentees mailing list
[email protected]
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees