Thread (3 messages) 3 messages, 3 authors, 2021-03-26

Re: [PATCH] crypto: ux500: fix incorrect kernel-doc comment syntax

From: Herbert Xu <herbert@gondor.apana.org.au>
Date: 2021-03-26 09:35:37
Also in: linux-crypto, lkml

On Sun, Mar 21, 2021 at 05:39:12PM +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/ux500, 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/ux500/cryp/cryp.h at header causes this warning:

"warning: expecting prototype for ST(). Prototype was for _CRYP_H_() 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 <redacted>
---
 drivers/crypto/ux500/cryp/cryp.c      |  2 +-
 drivers/crypto/ux500/cryp/cryp.h      |  2 +-
 drivers/crypto/ux500/cryp/cryp_core.c |  2 +-
 drivers/crypto/ux500/cryp/cryp_irq.c  |  2 +-
 drivers/crypto/ux500/cryp/cryp_irq.h  |  4 ++--
 drivers/crypto/ux500/cryp/cryp_irqp.h |  4 ++--
 drivers/crypto/ux500/cryp/cryp_p.h    | 14 +++++++-------
 7 files changed, 15 insertions(+), 15 deletions(-)
Patch applied.  Thanks.
-- 
Email: Herbert Xu [off-list ref]
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
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help