Re: [PATCH] ALSA: asihpi: fix comment syntax in file headers
From: Randy Dunlap <hidden>
Date: 2021-03-17 20:41:57
Also in:
alsa-devel, lkml
On 3/17/21 1:21 PM, Aditya Srivastava wrote:
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. Signed-off-by: Aditya Srivastava <redacted>
Acked-by: Randy Dunlap <redacted> Thanks.
quoted hunk ↗ jump to hunk
--- * Applies perfectly on next-20210312 sound/pci/asihpi/hpicmn.h | 2 +- sound/pci/asihpi/hpidspcd.h | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-)diff --git a/sound/pci/asihpi/hpicmn.h b/sound/pci/asihpi/hpicmn.h index de3bedd29d94..8ec656cf8848 100644 --- a/sound/pci/asihpi/hpicmn.h +++ b/sound/pci/asihpi/hpicmn.h@@ -1,5 +1,5 @@ /* SPDX-License-Identifier: GPL-2.0-only */ -/** +/* AudioScience HPI driver Copyright (C) 1997-2014 AudioScience Inc. <support@audioscience.com>diff --git a/sound/pci/asihpi/hpidspcd.h b/sound/pci/asihpi/hpidspcd.h index a01e8c6092bd..9f1468ed7096 100644 --- a/sound/pci/asihpi/hpidspcd.h +++ b/sound/pci/asihpi/hpidspcd.h@@ -1,6 +1,6 @@ /* SPDX-License-Identifier: GPL-2.0-only */ /***********************************************************************/ -/** +/* AudioScience HPI driver Copyright (C) 1997-2011 AudioScience Inc. <support@audioscience.com>
-- ~Randy _______________________________________________ Linux-kernel-mentees mailing list Linux-kernel-mentees@lists.linuxfoundation.org https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees