[PATCH] crypto: nx: fix incorrect kernel-doc comment syntax in files
herbert at gondor.apana.org.au
Fri Mar 26 09:34:56 UTC 2021
On Sun, Mar 21, 2021 at 06:00:07PM +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/nx, 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 the header lines for
> drivers/crypto/nx/nx-sha256.c at header causes these warnings:
> "warning: Function parameter or member 'tfm' not described in 'nx_crypto_ctx_sha256_init'"
> "warning: expecting prototype for SHA(). Prototype was for nx_crypto_ctx_sha256_init() instead"
> Similarly for other files too.
> 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 at gmail.com>
> * Applies perfectly on next-20210319
> drivers/crypto/nx/nx-aes-cbc.c | 2 +-
> drivers/crypto/nx/nx-aes-ccm.c | 2 +-
> drivers/crypto/nx/nx-aes-ctr.c | 2 +-
> drivers/crypto/nx/nx-aes-ecb.c | 2 +-
> drivers/crypto/nx/nx-aes-gcm.c | 2 +-
> drivers/crypto/nx/nx-aes-xcbc.c | 2 +-
> drivers/crypto/nx/nx-sha256.c | 2 +-
> drivers/crypto/nx/nx-sha512.c | 2 +-
> drivers/crypto/nx/nx.c | 2 +-
> drivers/crypto/nx/nx_debugfs.c | 2 +-
> 10 files changed, 10 insertions(+), 10 deletions(-)
Patch applied. Thanks.
Email: Herbert Xu <herbert at gondor.apana.org.au>
Home Page: http://gondor.apana.org.au/~herbert/
PGP Key: http://gondor.apana.org.au/~herbert/pubkey.txt
More information about the Linux-kernel-mentees