From: Herbert Xu <herbert@gondor.apana.org.au>
To: Aditya Srivastava <yashsri421@gmail.com>
Cc: nayna@linux.ibm.com, corbet@lwn.net, mpe@ellerman.id.au,
rdunlap@infradead.org, linuxppc-dev@lists.ozlabs.org,
linux-kernel@vger.kernel.org, pfsmorigo@gmail.com,
linux-crypto@vger.kernel.org, benh@kernel.crashing.org,
leitao@debian.org,
linux-kernel-mentees@lists.linuxfoundation.org,
davem@davemloft.net, paulus@samba.org
Subject: Re: [PATCH] crypto: vmx: fix incorrect kernel-doc comment syntax in files
Date: Fri, 26 Mar 2021 20:34:24 +1100 [thread overview]
Message-ID: <20210326093424.GP12658@gondor.apana.org.au> (raw)
In-Reply-To: <20210320202525.12562-1-yashsri421@gmail.com>
On Sun, Mar 21, 2021 at 01:55:25AM +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/vmx, 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 line for
> drivers/crypto/vmx/vmx.c causes this warning by kernel-doc:
>
> "warning: expecting prototype for Routines supporting VMX instructions on the Power 8(). Prototype was for p8_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@gmail.com>
> ---
> * Applies perfectly on next-20210319
>
> drivers/crypto/vmx/aes.c | 2 +-
> drivers/crypto/vmx/aes_cbc.c | 2 +-
> drivers/crypto/vmx/aes_ctr.c | 2 +-
> drivers/crypto/vmx/aes_xts.c | 2 +-
> drivers/crypto/vmx/ghash.c | 2 +-
> drivers/crypto/vmx/vmx.c | 2 +-
> 6 files changed, 6 insertions(+), 6 deletions(-)
Patch applied. Thanks.
--
Email: Herbert Xu <herbert@gondor.apana.org.au>
Home Page: http://gondor.apana.org.au/~herbert/
PGP Key: http://gondor.apana.org.au/~herbert/pubkey.txt
_______________________________________________
Linux-kernel-mentees mailing list
Linux-kernel-mentees@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees
next prev parent reply other threads:[~2021-03-26 10:00 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-03-20 20:25 [PATCH] crypto: vmx: fix incorrect kernel-doc comment syntax in files Aditya Srivastava
2021-03-26 6:02 ` Daniel Axtens
2021-03-26 9:34 ` Herbert Xu [this message]
-- strict thread matches above, loose matches on Subject: below --
2021-03-20 20:20 Aditya Srivastava
2021-03-20 20:28 ` Aditya Srivastava
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20210326093424.GP12658@gondor.apana.org.au \
--to=herbert@gondor.apana.org.au \
--cc=benh@kernel.crashing.org \
--cc=corbet@lwn.net \
--cc=davem@davemloft.net \
--cc=leitao@debian.org \
--cc=linux-crypto@vger.kernel.org \
--cc=linux-kernel-mentees@lists.linuxfoundation.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linuxppc-dev@lists.ozlabs.org \
--cc=mpe@ellerman.id.au \
--cc=nayna@linux.ibm.com \
--cc=paulus@samba.org \
--cc=pfsmorigo@gmail.com \
--cc=rdunlap@infradead.org \
--cc=yashsri421@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
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).