summaryrefslogtreecommitdiff
path: root/Documentation/SubmittingPatches
diff options
context:
space:
mode:
authorAditya Srivastava <yashsri421@gmail.com>2021-03-21 15:30:07 +0300
committerHerbert Xu <herbert@gondor.apana.org.au>2021-03-26 12:15:58 +0300
commit10cb823bbacd2626cca8d89a7dba175c3ae5cf07 (patch)
tree1f6476453d3714bfe80d3050c1a00c9b3a94c0b4 /Documentation/SubmittingPatches
parentce668da5f11e3aeed49843980b70529aa61f4275 (diff)
downloadlinux-10cb823bbacd2626cca8d89a7dba175c3ae5cf07.tar.xz
crypto: nx - fix incorrect kernel-doc comment syntax in files
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@gmail.com> Acked-by: Randy Dunlap <rdunlap@infradead.org> Signed-off-by: Herbert Xu <herbert@gondor.apana.org.au>
Diffstat (limited to 'Documentation/SubmittingPatches')
0 files changed, 0 insertions, 0 deletions