linux-kernel - Re: [PATCH] crypto: amcc: fix incorrect kernel-doc comment syntax in files

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]

Message-ID: <20210326093434.GQ12658@gondor.apana.org.au>
Date:   Fri, 26 Mar 2021 20:34:34 +1100
From:   Herbert Xu <herbert@...dor.apana.org.au>
To:     Aditya Srivastava <yashsri421@...il.com>
Cc:     lukas.bulwahn@...il.com, corbet@....net, rdunlap@...radead.org,
        linux-kernel-mentees@...ts.linuxfoundation.org,
        davem@...emloft.net, linux-crypto@...r.kernel.org,
        linux-kernel@...r.kernel.org
Subject: Re: [PATCH] crypto: amcc: fix incorrect kernel-doc comment syntax in
 files

On Sun, Mar 21, 2021 at 05:38:32PM +0530, Aditya Srivastava wrote:
> The opening comment mark '/**' is used for highlighting the beginning of
> kernel-doc comments.
> There are certain files in drivers/crypto/amcc, which follow this syntax,
> but the content inside does not comply with kernel-doc.
> Such lines were probably not meant for kernel-doc parsing, but are parsed
> due to the presence of kernel-doc like comment syntax(i.e, '/**'), which
> causes unexpected warnings from kernel-doc.
> 
> E.g., presence of kernel-doc like comment in
> drivers/crypto/amcc/crypto4xx_alg.c at header, and some other lines,
> causes these warnings by kernel-doc:
> 
> "warning: expecting prototype for AMCC SoC PPC4xx Crypto Driver(). Prototype was for set_dynamic_sa_command_0() instead"
> "warning: Function parameter or member 'dir' not described in 'set_dynamic_sa_command_0'"
> etc..
> 
> Provide a simple fix by replacing such occurrences with general comment
> format, i.e. '/*', to prevent kernel-doc from parsing it.
> 
> Signed-off-by: Aditya Srivastava <yashsri421@...il.com>
> ---
>  drivers/crypto/amcc/crypto4xx_alg.c     | 12 ++++++------
>  drivers/crypto/amcc/crypto4xx_core.c    | 18 +++++++++---------
>  drivers/crypto/amcc/crypto4xx_core.h    |  4 ++--
>  drivers/crypto/amcc/crypto4xx_reg_def.h |  8 ++++----
>  drivers/crypto/amcc/crypto4xx_sa.h      | 18 +++++++++---------
>  drivers/crypto/amcc/crypto4xx_trng.h    |  2 +-
>  6 files changed, 31 insertions(+), 31 deletions(-)

Patch applied.  Thanks.
-- 
Email: Herbert Xu <herbert@...dor.apana.org.au>
Home Page: http://gondor.apana.org.au/~herbert/
PGP Key: http://gondor.apana.org.au/~herbert/pubkey.txt