linux-kernel - Re: [PATCH] ALSA: ctxfi: fix comment syntax in file headers

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives
Hash Suite: Windows password security audit tool. GUI, reports in PDF.
[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]
Message-ID: <68e0dfd9-ed58-dec3-31b7-c5384d8640f8@infradead.org>
Date:   Wed, 17 Mar 2021 13:50:58 -0700
From:   Randy Dunlap <rdunlap@...radead.org>
To:     Aditya Srivastava <yashsri421@...il.com>,
        alsa-devel@...a-project.org
Cc:     lukas.bulwahn@...il.com,
        linux-kernel-mentees@...ts.linuxfoundation.org, perex@...ex.cz,
        tiwai@...e.com, pierre-louis.bossart@...ux.intel.com,
        linux-kernel@...r.kernel.org
Subject: Re: [PATCH] ALSA: ctxfi: fix comment syntax in file headers

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@...il.com>

Acked-by: Randy Dunlap <rdunlap@...radead.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