linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH] ALSA: ctxfi: fix comment syntax in file headers
@ 2021-03-17 20:39 Aditya Srivastava
  2021-03-17 20:50 ` Randy Dunlap
  2021-03-18  9:14 ` Takashi Iwai
  0 siblings, 2 replies; 3+ messages in thread
From: Aditya Srivastava @ 2021-03-17 20:39 UTC (permalink / raw)
  To: alsa-devel
  Cc: yashsri421, lukas.bulwahn, linux-kernel-mentees, perex, tiwai,
	pierre-louis.bossart, linux-kernel

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.

Signed-off-by: Aditya Srivastava <yashsri421@gmail.com>
---
 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(-)

diff --git a/sound/pci/ctxfi/ct20k1reg.h b/sound/pci/ctxfi/ct20k1reg.h
index d4bfee499fb1..05bb006c0f4c 100644
--- a/sound/pci/ctxfi/ct20k1reg.h
+++ b/sound/pci/ctxfi/ct20k1reg.h
@@ -1,5 +1,5 @@
 /* SPDX-License-Identifier: GPL-2.0-only */
-/**
+/*
  * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved.
  */
 
diff --git a/sound/pci/ctxfi/ct20k2reg.h b/sound/pci/ctxfi/ct20k2reg.h
index af94ea66fdda..02f67828eabe 100644
--- a/sound/pci/ctxfi/ct20k2reg.h
+++ b/sound/pci/ctxfi/ct20k2reg.h
@@ -1,5 +1,5 @@
 /* SPDX-License-Identifier: GPL-2.0-only */
-/**
+/*
  * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved.
  */
 
diff --git a/sound/pci/ctxfi/ctamixer.c b/sound/pci/ctxfi/ctamixer.c
index d4ff377eb3a3..da6e6350ceaf 100644
--- a/sound/pci/ctxfi/ctamixer.c
+++ b/sound/pci/ctxfi/ctamixer.c
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: GPL-2.0-only
-/**
+/*
  * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved.
  *
  * @File	ctamixer.c
diff --git a/sound/pci/ctxfi/ctamixer.h b/sound/pci/ctxfi/ctamixer.h
index 4fafb397abed..4498e6139d0e 100644
--- a/sound/pci/ctxfi/ctamixer.h
+++ b/sound/pci/ctxfi/ctamixer.h
@@ -1,5 +1,5 @@
 /* SPDX-License-Identifier: GPL-2.0-only */
-/**
+/*
  * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved.
  *
  * @File	ctamixer.h
diff --git a/sound/pci/ctxfi/ctatc.c b/sound/pci/ctxfi/ctatc.c
index f8ac96cf38a4..78f35e88aed6 100644
--- a/sound/pci/ctxfi/ctatc.c
+++ b/sound/pci/ctxfi/ctatc.c
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: GPL-2.0-only
-/**
+/*
  * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved.
  *
  * @File    ctatc.c
diff --git a/sound/pci/ctxfi/ctatc.h b/sound/pci/ctxfi/ctatc.h
index ac31b32b277b..0bc7b71d910b 100644
--- a/sound/pci/ctxfi/ctatc.h
+++ b/sound/pci/ctxfi/ctatc.h
@@ -1,5 +1,5 @@
 /* SPDX-License-Identifier: GPL-2.0-only */
-/**
+/*
  * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved.
  *
  * @File	ctatc.h
diff --git a/sound/pci/ctxfi/ctdaio.c b/sound/pci/ctxfi/ctdaio.c
index 4cb47b5a792c..f589da045342 100644
--- a/sound/pci/ctxfi/ctdaio.c
+++ b/sound/pci/ctxfi/ctdaio.c
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: GPL-2.0-only
-/**
+/*
  * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved.
  *
  * @File	ctdaio.c
diff --git a/sound/pci/ctxfi/ctdaio.h b/sound/pci/ctxfi/ctdaio.h
index 431583bb0a3e..bd6310f48013 100644
--- a/sound/pci/ctxfi/ctdaio.h
+++ b/sound/pci/ctxfi/ctdaio.h
@@ -1,5 +1,5 @@
 /* SPDX-License-Identifier: GPL-2.0-only */
-/**
+/*
  * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved.
  *
  * @File	ctdaio.h
diff --git a/sound/pci/ctxfi/cthardware.h b/sound/pci/ctxfi/cthardware.h
index 9e6b83bd432d..f406b626a28c 100644
--- a/sound/pci/ctxfi/cthardware.h
+++ b/sound/pci/ctxfi/cthardware.h
@@ -1,5 +1,5 @@
 /* SPDX-License-Identifier: GPL-2.0-only */
-/**
+/*
  * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved.
  *
  * @File	cthardware.h
diff --git a/sound/pci/ctxfi/cthw20k1.h b/sound/pci/ctxfi/cthw20k1.h
index b7cbe82d71bd..ffb019abf651 100644
--- a/sound/pci/ctxfi/cthw20k1.h
+++ b/sound/pci/ctxfi/cthw20k1.h
@@ -1,5 +1,5 @@
 /* SPDX-License-Identifier: GPL-2.0-only */
-/**
+/*
  * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved.
  *
  * @File	cthw20k1.h
diff --git a/sound/pci/ctxfi/cthw20k2.h b/sound/pci/ctxfi/cthw20k2.h
index 797b13dcd84c..6993a3d5277a 100644
--- a/sound/pci/ctxfi/cthw20k2.h
+++ b/sound/pci/ctxfi/cthw20k2.h
@@ -1,5 +1,5 @@
 /* SPDX-License-Identifier: GPL-2.0-only */
-/**
+/*
  * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved.
  *
  * @File	cthw20k2.h
diff --git a/sound/pci/ctxfi/ctimap.h b/sound/pci/ctxfi/ctimap.h
index 79bc94bce4d5..49b1bb831410 100644
--- a/sound/pci/ctxfi/ctimap.h
+++ b/sound/pci/ctxfi/ctimap.h
@@ -1,5 +1,5 @@
 /* SPDX-License-Identifier: GPL-2.0-only */
-/**
+/*
  * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved.
  *
  * @File	ctimap.h
diff --git a/sound/pci/ctxfi/ctmixer.h b/sound/pci/ctxfi/ctmixer.h
index 770dc18a85e8..e812f6c93b41 100644
--- a/sound/pci/ctxfi/ctmixer.h
+++ b/sound/pci/ctxfi/ctmixer.h
@@ -1,5 +1,5 @@
 /* SPDX-License-Identifier: GPL-2.0-only */
-/**
+/*
  * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved.
  *
  * @File	ctmixer.h
diff --git a/sound/pci/ctxfi/ctpcm.h b/sound/pci/ctxfi/ctpcm.h
index dfa1c62f7d1e..8b39bdd262b4 100644
--- a/sound/pci/ctxfi/ctpcm.h
+++ b/sound/pci/ctxfi/ctpcm.h
@@ -1,5 +1,5 @@
 /* SPDX-License-Identifier: GPL-2.0-only */
-/**
+/*
  * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved.
  *
  * @File	ctpcm.h
diff --git a/sound/pci/ctxfi/ctresource.c b/sound/pci/ctxfi/ctresource.c
index 6d0a01b189e1..81ad26934518 100644
--- a/sound/pci/ctxfi/ctresource.c
+++ b/sound/pci/ctxfi/ctresource.c
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: GPL-2.0-only
-/**
+/*
  * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved.
  *
  * @File	ctresource.c
diff --git a/sound/pci/ctxfi/ctresource.h b/sound/pci/ctxfi/ctresource.h
index 93e47488a1c1..fdbfd808816d 100644
--- a/sound/pci/ctxfi/ctresource.h
+++ b/sound/pci/ctxfi/ctresource.h
@@ -1,5 +1,5 @@
 /* SPDX-License-Identifier: GPL-2.0-only */
-/**
+/*
  * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved.
  *
  * @File	ctresource.h
diff --git a/sound/pci/ctxfi/ctsrc.c b/sound/pci/ctxfi/ctsrc.c
index 37c18ce84974..bd4697b44233 100644
--- a/sound/pci/ctxfi/ctsrc.c
+++ b/sound/pci/ctxfi/ctsrc.c
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: GPL-2.0-only
-/**
+/*
  * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved.
  *
  * @File	ctsrc.c
diff --git a/sound/pci/ctxfi/ctsrc.h b/sound/pci/ctxfi/ctsrc.h
index 1204962280c8..1124daf50c9b 100644
--- a/sound/pci/ctxfi/ctsrc.h
+++ b/sound/pci/ctxfi/ctsrc.h
@@ -1,5 +1,5 @@
 /* SPDX-License-Identifier: GPL-2.0-only */
-/**
+/*
  * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved.
  *
  * @File	ctsrc.h
diff --git a/sound/pci/ctxfi/ctvmem.c b/sound/pci/ctxfi/ctvmem.c
index bde28aa9e139..7a805c4a58e1 100644
--- a/sound/pci/ctxfi/ctvmem.c
+++ b/sound/pci/ctxfi/ctvmem.c
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: GPL-2.0-only
-/**
+/*
  * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved.
  *
  * @File    ctvmem.c
diff --git a/sound/pci/ctxfi/ctvmem.h b/sound/pci/ctxfi/ctvmem.h
index 54818a3c245d..da54cbcdb0be 100644
--- a/sound/pci/ctxfi/ctvmem.h
+++ b/sound/pci/ctxfi/ctvmem.h
@@ -1,5 +1,5 @@
 /* SPDX-License-Identifier: GPL-2.0-only */
-/**
+/*
  * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved.
  *
  * @File    ctvmem.h
-- 
2.17.1


^ permalink raw reply related	[flat|nested] 3+ messages in thread
* Re: [PATCH] ALSA: ctxfi: fix comment syntax in file headers
  2021-03-17 20:39 [PATCH] ALSA: ctxfi: fix comment syntax in file headers Aditya Srivastava
@ 2021-03-17 20:50 ` Randy Dunlap
  2021-03-18  9:14 ` Takashi Iwai
  1 sibling, 0 replies; 3+ messages in thread
From: Randy Dunlap @ 2021-03-17 20:50 UTC (permalink / raw)
  To: Aditya Srivastava, alsa-devel
  Cc: lukas.bulwahn, linux-kernel-mentees, perex, tiwai,
	pierre-louis.bossart, linux-kernel

On 3/17/21 1:39 PM, Aditya Srivastava wrote:
> 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.
> 
> Signed-off-by: Aditya Srivastava <yashsri421@gmail.com>

Acked-by: Randy Dunlap <rdunlap@infradead.org>

Thanks.

> ---
>  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(-)
> 
> diff --git a/sound/pci/ctxfi/ct20k1reg.h b/sound/pci/ctxfi/ct20k1reg.h
> index d4bfee499fb1..05bb006c0f4c 100644
> --- a/sound/pci/ctxfi/ct20k1reg.h
> +++ b/sound/pci/ctxfi/ct20k1reg.h
> @@ -1,5 +1,5 @@
>  /* SPDX-License-Identifier: GPL-2.0-only */
> -/**
> +/*
>   * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved.
>   */
>  
> diff --git a/sound/pci/ctxfi/ct20k2reg.h b/sound/pci/ctxfi/ct20k2reg.h
> index af94ea66fdda..02f67828eabe 100644
> --- a/sound/pci/ctxfi/ct20k2reg.h
> +++ b/sound/pci/ctxfi/ct20k2reg.h
> @@ -1,5 +1,5 @@
>  /* SPDX-License-Identifier: GPL-2.0-only */
> -/**
> +/*
>   * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved.
>   */
>  
> diff --git a/sound/pci/ctxfi/ctamixer.c b/sound/pci/ctxfi/ctamixer.c
> index d4ff377eb3a3..da6e6350ceaf 100644
> --- a/sound/pci/ctxfi/ctamixer.c
> +++ b/sound/pci/ctxfi/ctamixer.c
> @@ -1,5 +1,5 @@
>  // SPDX-License-Identifier: GPL-2.0-only
> -/**
> +/*
>   * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved.
>   *
>   * @File	ctamixer.c
> diff --git a/sound/pci/ctxfi/ctamixer.h b/sound/pci/ctxfi/ctamixer.h
> index 4fafb397abed..4498e6139d0e 100644
> --- a/sound/pci/ctxfi/ctamixer.h
> +++ b/sound/pci/ctxfi/ctamixer.h
> @@ -1,5 +1,5 @@
>  /* SPDX-License-Identifier: GPL-2.0-only */
> -/**
> +/*
>   * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved.
>   *
>   * @File	ctamixer.h
> diff --git a/sound/pci/ctxfi/ctatc.c b/sound/pci/ctxfi/ctatc.c
> index f8ac96cf38a4..78f35e88aed6 100644
> --- a/sound/pci/ctxfi/ctatc.c
> +++ b/sound/pci/ctxfi/ctatc.c
> @@ -1,5 +1,5 @@
>  // SPDX-License-Identifier: GPL-2.0-only
> -/**
> +/*
>   * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved.
>   *
>   * @File    ctatc.c
> diff --git a/sound/pci/ctxfi/ctatc.h b/sound/pci/ctxfi/ctatc.h
> index ac31b32b277b..0bc7b71d910b 100644
> --- a/sound/pci/ctxfi/ctatc.h
> +++ b/sound/pci/ctxfi/ctatc.h
> @@ -1,5 +1,5 @@
>  /* SPDX-License-Identifier: GPL-2.0-only */
> -/**
> +/*
>   * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved.
>   *
>   * @File	ctatc.h
> diff --git a/sound/pci/ctxfi/ctdaio.c b/sound/pci/ctxfi/ctdaio.c
> index 4cb47b5a792c..f589da045342 100644
> --- a/sound/pci/ctxfi/ctdaio.c
> +++ b/sound/pci/ctxfi/ctdaio.c
> @@ -1,5 +1,5 @@
>  // SPDX-License-Identifier: GPL-2.0-only
> -/**
> +/*
>   * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved.
>   *
>   * @File	ctdaio.c
> diff --git a/sound/pci/ctxfi/ctdaio.h b/sound/pci/ctxfi/ctdaio.h
> index 431583bb0a3e..bd6310f48013 100644
> --- a/sound/pci/ctxfi/ctdaio.h
> +++ b/sound/pci/ctxfi/ctdaio.h
> @@ -1,5 +1,5 @@
>  /* SPDX-License-Identifier: GPL-2.0-only */
> -/**
> +/*
>   * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved.
>   *
>   * @File	ctdaio.h
> diff --git a/sound/pci/ctxfi/cthardware.h b/sound/pci/ctxfi/cthardware.h
> index 9e6b83bd432d..f406b626a28c 100644
> --- a/sound/pci/ctxfi/cthardware.h
> +++ b/sound/pci/ctxfi/cthardware.h
> @@ -1,5 +1,5 @@
>  /* SPDX-License-Identifier: GPL-2.0-only */
> -/**
> +/*
>   * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved.
>   *
>   * @File	cthardware.h
> diff --git a/sound/pci/ctxfi/cthw20k1.h b/sound/pci/ctxfi/cthw20k1.h
> index b7cbe82d71bd..ffb019abf651 100644
> --- a/sound/pci/ctxfi/cthw20k1.h
> +++ b/sound/pci/ctxfi/cthw20k1.h
> @@ -1,5 +1,5 @@
>  /* SPDX-License-Identifier: GPL-2.0-only */
> -/**
> +/*
>   * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved.
>   *
>   * @File	cthw20k1.h
> diff --git a/sound/pci/ctxfi/cthw20k2.h b/sound/pci/ctxfi/cthw20k2.h
> index 797b13dcd84c..6993a3d5277a 100644
> --- a/sound/pci/ctxfi/cthw20k2.h
> +++ b/sound/pci/ctxfi/cthw20k2.h
> @@ -1,5 +1,5 @@
>  /* SPDX-License-Identifier: GPL-2.0-only */
> -/**
> +/*
>   * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved.
>   *
>   * @File	cthw20k2.h
> diff --git a/sound/pci/ctxfi/ctimap.h b/sound/pci/ctxfi/ctimap.h
> index 79bc94bce4d5..49b1bb831410 100644
> --- a/sound/pci/ctxfi/ctimap.h
> +++ b/sound/pci/ctxfi/ctimap.h
> @@ -1,5 +1,5 @@
>  /* SPDX-License-Identifier: GPL-2.0-only */
> -/**
> +/*
>   * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved.
>   *
>   * @File	ctimap.h
> diff --git a/sound/pci/ctxfi/ctmixer.h b/sound/pci/ctxfi/ctmixer.h
> index 770dc18a85e8..e812f6c93b41 100644
> --- a/sound/pci/ctxfi/ctmixer.h
> +++ b/sound/pci/ctxfi/ctmixer.h
> @@ -1,5 +1,5 @@
>  /* SPDX-License-Identifier: GPL-2.0-only */
> -/**
> +/*
>   * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved.
>   *
>   * @File	ctmixer.h
> diff --git a/sound/pci/ctxfi/ctpcm.h b/sound/pci/ctxfi/ctpcm.h
> index dfa1c62f7d1e..8b39bdd262b4 100644
> --- a/sound/pci/ctxfi/ctpcm.h
> +++ b/sound/pci/ctxfi/ctpcm.h
> @@ -1,5 +1,5 @@
>  /* SPDX-License-Identifier: GPL-2.0-only */
> -/**
> +/*
>   * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved.
>   *
>   * @File	ctpcm.h
> diff --git a/sound/pci/ctxfi/ctresource.c b/sound/pci/ctxfi/ctresource.c
> index 6d0a01b189e1..81ad26934518 100644
> --- a/sound/pci/ctxfi/ctresource.c
> +++ b/sound/pci/ctxfi/ctresource.c
> @@ -1,5 +1,5 @@
>  // SPDX-License-Identifier: GPL-2.0-only
> -/**
> +/*
>   * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved.
>   *
>   * @File	ctresource.c
> diff --git a/sound/pci/ctxfi/ctresource.h b/sound/pci/ctxfi/ctresource.h
> index 93e47488a1c1..fdbfd808816d 100644
> --- a/sound/pci/ctxfi/ctresource.h
> +++ b/sound/pci/ctxfi/ctresource.h
> @@ -1,5 +1,5 @@
>  /* SPDX-License-Identifier: GPL-2.0-only */
> -/**
> +/*
>   * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved.
>   *
>   * @File	ctresource.h
> diff --git a/sound/pci/ctxfi/ctsrc.c b/sound/pci/ctxfi/ctsrc.c
> index 37c18ce84974..bd4697b44233 100644
> --- a/sound/pci/ctxfi/ctsrc.c
> +++ b/sound/pci/ctxfi/ctsrc.c
> @@ -1,5 +1,5 @@
>  // SPDX-License-Identifier: GPL-2.0-only
> -/**
> +/*
>   * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved.
>   *
>   * @File	ctsrc.c
> diff --git a/sound/pci/ctxfi/ctsrc.h b/sound/pci/ctxfi/ctsrc.h
> index 1204962280c8..1124daf50c9b 100644
> --- a/sound/pci/ctxfi/ctsrc.h
> +++ b/sound/pci/ctxfi/ctsrc.h
> @@ -1,5 +1,5 @@
>  /* SPDX-License-Identifier: GPL-2.0-only */
> -/**
> +/*
>   * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved.
>   *
>   * @File	ctsrc.h
> diff --git a/sound/pci/ctxfi/ctvmem.c b/sound/pci/ctxfi/ctvmem.c
> index bde28aa9e139..7a805c4a58e1 100644
> --- a/sound/pci/ctxfi/ctvmem.c
> +++ b/sound/pci/ctxfi/ctvmem.c
> @@ -1,5 +1,5 @@
>  // SPDX-License-Identifier: GPL-2.0-only
> -/**
> +/*
>   * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved.
>   *
>   * @File    ctvmem.c
> diff --git a/sound/pci/ctxfi/ctvmem.h b/sound/pci/ctxfi/ctvmem.h
> index 54818a3c245d..da54cbcdb0be 100644
> --- a/sound/pci/ctxfi/ctvmem.h
> +++ b/sound/pci/ctxfi/ctvmem.h
> @@ -1,5 +1,5 @@
>  /* SPDX-License-Identifier: GPL-2.0-only */
> -/**
> +/*
>   * Copyright (C) 2008, Creative Technology Ltd. All Rights Reserved.
>   *
>   * @File    ctvmem.h
> 


-- 
~Randy


^ permalink raw reply	[flat|nested] 3+ messages in thread
* Re: [PATCH] ALSA: ctxfi: fix comment syntax in file headers
  2021-03-17 20:39 [PATCH] ALSA: ctxfi: fix comment syntax in file headers Aditya Srivastava
  2021-03-17 20:50 ` Randy Dunlap
@ 2021-03-18  9:14 ` Takashi Iwai
  1 sibling, 0 replies; 3+ messages in thread
From: Takashi Iwai @ 2021-03-18  9:14 UTC (permalink / raw)
  To: Aditya Srivastava
  Cc: alsa-devel, lukas.bulwahn, linux-kernel-mentees, perex, tiwai,
	pierre-louis.bossart, linux-kernel

On Wed, 17 Mar 2021 21:39:32 +0100,
Aditya Srivastava wrote:
> 
> 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.
> 
> Signed-off-by: Aditya Srivastava <yashsri421@gmail.com>

Applied now.  Thanks.


Takashi

^ permalink raw reply	[flat|nested] 3+ messages in thread
end of thread, other threads:[~2021-03-18  9:15 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-03-17 20:39 [PATCH] ALSA: ctxfi: fix comment syntax in file headers Aditya Srivastava
2021-03-17 20:50 ` Randy Dunlap
2021-03-18  9:14 ` Takashi Iwai

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).