Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

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>

authored by

Aditya Srivastava and committed by
Herbert Xu
10cb823b ce668da5

+7 -7
+1 -1
drivers/crypto/nx/nx-aes-ccm.c
··· 1 1 // SPDX-License-Identifier: GPL-2.0-only 2 - /** 2 + /* 3 3 * AES CCM routines supporting the Power 7+ Nest Accelerators driver 4 4 * 5 5 * Copyright (C) 2012 International Business Machines Inc.
+1 -1
drivers/crypto/nx/nx-aes-ctr.c
··· 1 1 // SPDX-License-Identifier: GPL-2.0-only 2 - /** 2 + /* 3 3 * AES CTR routines supporting the Power 7+ Nest Accelerators driver 4 4 * 5 5 * Copyright (C) 2011-2012 International Business Machines Inc.
+1 -1
drivers/crypto/nx/nx-aes-ecb.c
··· 1 1 // SPDX-License-Identifier: GPL-2.0-only 2 - /** 2 + /* 3 3 * AES ECB routines supporting the Power 7+ Nest Accelerators driver 4 4 * 5 5 * Copyright (C) 2011-2012 International Business Machines Inc.
+1 -1
drivers/crypto/nx/nx-aes-gcm.c
··· 1 1 // SPDX-License-Identifier: GPL-2.0-only 2 - /** 2 + /* 3 3 * AES GCM routines supporting the Power 7+ Nest Accelerators driver 4 4 * 5 5 * Copyright (C) 2012 International Business Machines Inc.
+1 -1
drivers/crypto/nx/nx-aes-xcbc.c
··· 1 1 // SPDX-License-Identifier: GPL-2.0-only 2 - /** 2 + /* 3 3 * AES XCBC routines supporting the Power 7+ Nest Accelerators driver 4 4 * 5 5 * Copyright (C) 2011-2012 International Business Machines Inc.
+1 -1
drivers/crypto/nx/nx-sha256.c
··· 1 1 // SPDX-License-Identifier: GPL-2.0-only 2 - /** 2 + /* 3 3 * SHA-256 routines supporting the Power 7+ Nest Accelerators driver 4 4 * 5 5 * Copyright (C) 2011-2012 International Business Machines Inc.
+1 -1
drivers/crypto/nx/nx-sha512.c
··· 1 1 // SPDX-License-Identifier: GPL-2.0-only 2 - /** 2 + /* 3 3 * SHA-512 routines supporting the Power 7+ Nest Accelerators driver 4 4 * 5 5 * Copyright (C) 2011-2012 International Business Machines Inc.