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

crypto: vmx - 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/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>
Reviewed-by: Daniel Axtens <dja@axtens.net>
Signed-off-by: Herbert Xu <herbert@gondor.apana.org.au>

authored by

Aditya Srivastava and committed by
Herbert Xu
dbb153c0 8bbecfb4

+5 -5
+1 -1
drivers/crypto/vmx/aes.c
··· 1 1 // SPDX-License-Identifier: GPL-2.0-only 2 - /** 2 + /* 3 3 * AES routines supporting VMX instructions on the Power 8 4 4 * 5 5 * Copyright (C) 2015 International Business Machines Inc.
+1 -1
drivers/crypto/vmx/aes_cbc.c
··· 1 1 // SPDX-License-Identifier: GPL-2.0-only 2 - /** 2 + /* 3 3 * AES CBC routines supporting VMX instructions on the Power 8 4 4 * 5 5 * Copyright (C) 2015 International Business Machines Inc.
+1 -1
drivers/crypto/vmx/aes_ctr.c
··· 1 1 // SPDX-License-Identifier: GPL-2.0-only 2 - /** 2 + /* 3 3 * AES CTR routines supporting VMX instructions on the Power 8 4 4 * 5 5 * Copyright (C) 2015 International Business Machines Inc.
+1 -1
drivers/crypto/vmx/aes_xts.c
··· 1 1 // SPDX-License-Identifier: GPL-2.0-only 2 - /** 2 + /* 3 3 * AES XTS routines supporting VMX In-core instructions on Power 8 4 4 * 5 5 * Copyright (C) 2015 International Business Machines Inc.
+1 -1
drivers/crypto/vmx/ghash.c
··· 1 1 // SPDX-License-Identifier: GPL-2.0 2 - /** 2 + /* 3 3 * GHASH routines supporting VMX instructions on the Power 8 4 4 * 5 5 * Copyright (C) 2015, 2019 International Business Machines Inc.