ALSA: ctxfi: fix comment syntax in file headers
PATCH 1/1 ALSA: ctxfi: 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/ctxfi 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/ctxfi/ctresource.c causes this warning:
"warning: wrong kernel-doc identifier on line:
* Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved."
Similarly for other files too.
Provide a simple fix by replacing the kernel-doc like comment syntax with general format, i.e. "/*", to prevent kernel-doc from parsing it.
--- sound/pci/ctxfi/ct20k1reg.h | 2 +- sound/pci/ctxfi/ct20k2reg.h | 2 +- sound/pci/ctxfi/ctamixer.c | 2 +- sound/pci/ctxfi/ctamixer.h | 2 +- sound/pci/ctxfi/ctatc.c | 2 +- sound/pci/ctxfi/ctatc.h | 2 +- sound/pci/ctxfi/ctdaio.c | 2 +- sound/pci/ctxfi/ctdaio.h | 2 +- sound/pci/ctxfi/cthardware.h | 2 +- sound/pci/ctxfi/cthw20k1.h | 2 +- sound/pci/ctxfi/cthw20k2.h | 2 +- sound/pci/ctxfi/ctimap.h | 2 +- sound/pci/ctxfi/ctmixer.h | 2 +- sound/pci/ctxfi/ctpcm.h | 2 +- sound/pci/ctxfi/ctresource.c | 2 +- sound/pci/ctxfi/ctresource.h | 2 +- sound/pci/ctxfi/ctsrc.c | 2 +- sound/pci/ctxfi/ctsrc.h | 2 +- sound/pci/ctxfi/ctvmem.c | 2 +- sound/pci/ctxfi/ctvmem.h | 2 +- 20 files changed, 20 insertions(+), 20 deletions(-)
sound/pci/ctxfi/ct20k1reg.h +1 -1
@@ -1,5 +1,5 @@/* SPDX-License-Identifier: GPL-2.0-only */ -/** +/* * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved. */
sound/pci/ctxfi/ct20k2reg.h +1 -1
@@ -1,5 +1,5 @@/* SPDX-License-Identifier: GPL-2.0-only */ -/** +/* * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved. */
sound/pci/ctxfi/ctamixer.c +1 -1
@@ -1,5 +1,5 @@// SPDX-License-Identifier: GPL-2.0-only -/** +/* * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved. * * @File ctamixer.c
sound/pci/ctxfi/ctamixer.h +1 -1
@@ -1,5 +1,5 @@/* SPDX-License-Identifier: GPL-2.0-only */ -/** +/* * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved. * * @File ctamixer.h
sound/pci/ctxfi/ctatc.c +1 -1
@@ -1,5 +1,5 @@// SPDX-License-Identifier: GPL-2.0-only -/** +/* * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved. * * @File ctatc.c
sound/pci/ctxfi/ctatc.h +1 -1
@@ -1,5 +1,5 @@/* SPDX-License-Identifier: GPL-2.0-only */ -/** +/* * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved. * * @File ctatc.h
sound/pci/ctxfi/ctdaio.c +1 -1
@@ -1,5 +1,5 @@// SPDX-License-Identifier: GPL-2.0-only -/** +/* * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved. * * @File ctdaio.c
sound/pci/ctxfi/ctdaio.h +1 -1
@@ -1,5 +1,5 @@/* SPDX-License-Identifier: GPL-2.0-only */ -/** +/* * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved. * * @File ctdaio.h
sound/pci/ctxfi/cthardware.h +1 -1
@@ -1,5 +1,5 @@/* SPDX-License-Identifier: GPL-2.0-only */ -/** +/* * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved. * * @File cthardware.h
sound/pci/ctxfi/cthw20k1.h +1 -1
@@ -1,5 +1,5 @@/* SPDX-License-Identifier: GPL-2.0-only */ -/** +/* * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved. * * @File cthw20k1.h
sound/pci/ctxfi/cthw20k2.h +1 -1
@@ -1,5 +1,5 @@/* SPDX-License-Identifier: GPL-2.0-only */ -/** +/* * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved. * * @File cthw20k2.h
sound/pci/ctxfi/ctimap.h +1 -1
@@ -1,5 +1,5 @@/* SPDX-License-Identifier: GPL-2.0-only */ -/** +/* * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved. * * @File ctimap.h
sound/pci/ctxfi/ctmixer.h +1 -1
@@ -1,5 +1,5 @@/* SPDX-License-Identifier: GPL-2.0-only */ -/** +/* * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved. * * @File ctmixer.h
sound/pci/ctxfi/ctpcm.h +1 -1
@@ -1,5 +1,5 @@/* SPDX-License-Identifier: GPL-2.0-only */ -/** +/* * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved. * * @File ctpcm.h
sound/pci/ctxfi/ctresource.c +1 -1
@@ -1,5 +1,5 @@// SPDX-License-Identifier: GPL-2.0-only -/** +/* * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved. * * @File ctresource.c
sound/pci/ctxfi/ctresource.h +1 -1
@@ -1,5 +1,5 @@/* SPDX-License-Identifier: GPL-2.0-only */ -/** +/* * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved. * * @File ctresource.h
sound/pci/ctxfi/ctsrc.c +1 -1
@@ -1,5 +1,5 @@// SPDX-License-Identifier: GPL-2.0-only -/** +/* * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved. * * @File ctsrc.c
sound/pci/ctxfi/ctsrc.h +1 -1
@@ -1,5 +1,5 @@/* SPDX-License-Identifier: GPL-2.0-only */ -/** +/* * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved. * * @File ctsrc.h
sound/pci/ctxfi/ctvmem.c +1 -1
@@ -1,5 +1,5 @@// SPDX-License-Identifier: GPL-2.0-only -/** +/* * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved. * * @File ctvmem.c
sound/pci/ctxfi/ctvmem.h +1 -1
@@ -1,5 +1,5 @@/* SPDX-License-Identifier: GPL-2.0-only */ -/** +/* * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved. * * @File ctvmem.h
Signature · 6 lines
2.17.1 _______________________________________________ Linux-kernel-mentees mailing list [email protected] https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees
Quoted 11 lines · Aditya Srivastava
The opening comment mark '/**' is used for highlighting the beginning of kernel-doc comments.
There are files insound/pci/ctxfiwhich 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 onsound/pci/ctxfi/ctresource.ccauses this warning:
"warning: wrong kernel-doc identifier on line:
* Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved."
Quoted 6 lines
Similarly for other files too.
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 <[email protected]>
Thanks.
Quoted 244 lines
--- sound/pci/ctxfi/ct20k1reg.h | 2 +- sound/pci/ctxfi/ct20k2reg.h | 2 +- sound/pci/ctxfi/ctamixer.c | 2 +- sound/pci/ctxfi/ctamixer.h | 2 +- sound/pci/ctxfi/ctatc.c | 2 +- sound/pci/ctxfi/ctatc.h | 2 +- sound/pci/ctxfi/ctdaio.c | 2 +- sound/pci/ctxfi/ctdaio.h | 2 +- sound/pci/ctxfi/cthardware.h | 2 +- sound/pci/ctxfi/cthw20k1.h | 2 +- sound/pci/ctxfi/cthw20k2.h | 2 +- sound/pci/ctxfi/ctimap.h | 2 +- sound/pci/ctxfi/ctmixer.h | 2 +- sound/pci/ctxfi/ctpcm.h | 2 +- sound/pci/ctxfi/ctresource.c | 2 +- sound/pci/ctxfi/ctresource.h | 2 +- sound/pci/ctxfi/ctsrc.c | 2 +- sound/pci/ctxfi/ctsrc.h | 2 +- sound/pci/ctxfi/ctvmem.c | 2 +- sound/pci/ctxfi/ctvmem.h | 2 +- 20 files changed, 20 insertions(+), 20 deletions(-)sound/pci/ctxfi/ct20k1reg.h +1
-1@@ -1,5 +1,5 @@/* SPDX-License-Identifier: GPL-2.0-only */ -/** +/* * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved. */ sound/pci/ctxfi/ct20k2reg.h +1
-1@@ -1,5 +1,5 @@/* SPDX-License-Identifier: GPL-2.0-only */ -/** +/* * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved. */ sound/pci/ctxfi/ctamixer.c +1
-1@@ -1,5 +1,5 @@// SPDX-License-Identifier: GPL-2.0-only -/** +/* * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved. * * @File ctamixer.c sound/pci/ctxfi/ctamixer.h +1
-1@@ -1,5 +1,5 @@/* SPDX-License-Identifier: GPL-2.0-only */ -/** +/* * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved. * * @File ctamixer.h sound/pci/ctxfi/ctatc.c +1
-1@@ -1,5 +1,5 @@// SPDX-License-Identifier: GPL-2.0-only -/** +/* * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved. * * @File ctatc.c sound/pci/ctxfi/ctatc.h +1
-1@@ -1,5 +1,5 @@/* SPDX-License-Identifier: GPL-2.0-only */ -/** +/* * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved. * * @File ctatc.h sound/pci/ctxfi/ctdaio.c +1
-1@@ -1,5 +1,5 @@// SPDX-License-Identifier: GPL-2.0-only -/** +/* * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved. * * @File ctdaio.c sound/pci/ctxfi/ctdaio.h +1
-1@@ -1,5 +1,5 @@/* SPDX-License-Identifier: GPL-2.0-only */ -/** +/* * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved. * * @File ctdaio.h sound/pci/ctxfi/cthardware.h +1
-1@@ -1,5 +1,5 @@/* SPDX-License-Identifier: GPL-2.0-only */ -/** +/* * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved. * * @File cthardware.h sound/pci/ctxfi/cthw20k1.h +1
-1@@ -1,5 +1,5 @@/* SPDX-License-Identifier: GPL-2.0-only */ -/** +/* * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved. * * @File cthw20k1.h sound/pci/ctxfi/cthw20k2.h +1
-1@@ -1,5 +1,5 @@/* SPDX-License-Identifier: GPL-2.0-only */ -/** +/* * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved. * * @File cthw20k2.h sound/pci/ctxfi/ctimap.h +1
-1@@ -1,5 +1,5 @@/* SPDX-License-Identifier: GPL-2.0-only */ -/** +/* * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved. * * @File ctimap.h sound/pci/ctxfi/ctmixer.h +1
-1@@ -1,5 +1,5 @@/* SPDX-License-Identifier: GPL-2.0-only */ -/** +/* * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved. * * @File ctmixer.h sound/pci/ctxfi/ctpcm.h +1
-1@@ -1,5 +1,5 @@/* SPDX-License-Identifier: GPL-2.0-only */ -/** +/* * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved. * * @File ctpcm.h sound/pci/ctxfi/ctresource.c +1
-1@@ -1,5 +1,5 @@// SPDX-License-Identifier: GPL-2.0-only -/** +/* * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved. * * @File ctresource.c sound/pci/ctxfi/ctresource.h +1
-1@@ -1,5 +1,5 @@/* SPDX-License-Identifier: GPL-2.0-only */ -/** +/* * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved. * * @File ctresource.h sound/pci/ctxfi/ctsrc.c +1
-1@@ -1,5 +1,5 @@// SPDX-License-Identifier: GPL-2.0-only -/** +/* * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved. * * @File ctsrc.c sound/pci/ctxfi/ctsrc.h +1
-1@@ -1,5 +1,5 @@/* SPDX-License-Identifier: GPL-2.0-only */ -/** +/* * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved. * * @File ctsrc.h sound/pci/ctxfi/ctvmem.c +1
-1@@ -1,5 +1,5 @@// SPDX-License-Identifier: GPL-2.0-only -/** +/* * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved. * * @File ctvmem.c sound/pci/ctxfi/ctvmem.h +1
-1@@ -1,5 +1,5 @@/* SPDX-License-Identifier: GPL-2.0-only */ -/** +/* * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved. * * @File ctvmem.h
Signature · 6 lines
~Randy _______________________________________________ Linux-kernel-mentees mailing list [email protected] https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees
Quoted 12 lines · Aditya Srivastava
The opening comment mark '/**' is used for highlighting the beginning of kernel-doc comments.
There are files insound/pci/ctxfiwhich 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 onsound/pci/ctxfi/ctresource.ccauses this warning:
"warning: wrong kernel-doc identifier on line:
* Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved."
Quoted 6 lines
Similarly for other files too.
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 <[email protected]>
Applied now. Thanks.
Takashi
_______________________________________________
Linux-kernel-mentees mailing list
[email protected]
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees