linux-kernel - Re: [PATCH] ipac: tpci200: fix kernel-doc syntax and remove filename from file header

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] [day] [month] [year] [list]

Date:   Wed, 26 May 2021 12:05:44 +0200
From:   Samuel Iglesias Gonsálvez 
        <siglesias@...lia.com>
To:     Aditya Srivastava <yashsri421@...il.com>
Cc:     lukas.bulwahn@...il.com, rdunlap@...radead.org,
        linux-kernel-mentees@...ts.linuxfoundation.org,
        linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org,
        jens.taprogge@...rogge.org, gregkh@...uxfoundation.org,
        industrypack-devel@...ts.sourceforge.net
Subject: Re: [PATCH] ipac: tpci200: fix kernel-doc syntax and remove
 filename from file header

Acked-by: Samuel Iglesias Gonsalvez <siglesias@...lia.com>

Thanks,

Sam

On Sat, 2021-05-22 at 18:10 +0530, Aditya Srivastava wrote:
> The opening comment mark '/**' is used for highlighting the beginning
> of
> kernel-doc comments.
> The header for drivers/ipack/carriers/tpci200 follows this syntax,
> but the
> content inside does not comply with kernel-doc.
> 
> This line was probably not meant for kernel-doc parsing, but is
> parsed
> due to the presence of kernel-doc like comment syntax(i.e, '/**'),
> which
> causes unexpected warning from kernel-doc.
> 
> For e.g., running scripts/kernel-doc -none on
> drivers/ipack/carriers/tpci200.c emits:
> warning: This comment starts with '/**', but isn't a kernel-doc
> comment. Refer Documentation/doc-guide/kernel-doc.rst
>  * tpci200.c
> 
> Provide a simple fix by replacing this occurrence with general
> comment
> format, i.e. '/*', to prevent kernel-doc from parsing it.
> 
> Also remove the redundant file name from the comment headers.
> 
> Signed-off-by: Aditya Srivastava <yashsri421@...il.com>
> ---
>  drivers/ipack/carriers/tpci200.c | 4 +---
>  drivers/ipack/carriers/tpci200.h | 4 +---
>  2 files changed, 2 insertions(+), 6 deletions(-)
> 
> diff --git a/drivers/ipack/carriers/tpci200.c
> b/drivers/ipack/carriers/tpci200.c
> index ec71063fff76..a867906777bd 100644
> --- a/drivers/ipack/carriers/tpci200.c
> +++ b/drivers/ipack/carriers/tpci200.c
> @@ -1,7 +1,5 @@
>  // SPDX-License-Identifier: GPL-2.0-only
> -/**
> - * tpci200.c
> - *
> +/*
>   * driver for the TEWS TPCI-200 device
>   *
>   * Copyright (C) 2009-2012 CERN (www.cern.ch)
> diff --git a/drivers/ipack/carriers/tpci200.h
> b/drivers/ipack/carriers/tpci200.h
> index 2619f827e33f..e79ac64abcff 100644
> --- a/drivers/ipack/carriers/tpci200.h
> +++ b/drivers/ipack/carriers/tpci200.h
> @@ -1,7 +1,5 @@
>  /* SPDX-License-Identifier: GPL-2.0-only */
> -/**
> - * tpci200.h
> - *
> +/*
>   * driver for the carrier TEWS TPCI-200
>   *
>   * Copyright (C) 2009-2012 CERN (www.cern.ch)


Download attachment "signature.asc" of type "application/pgp-signature" (834 bytes)