crypto: vmx: fix incorrect kernel-doc comment syntax in files
PATCH 1/1 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.
---
* 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(-)
drivers/crypto/vmx/aes.c +1 -1
@@ -1,5 +1,5 @@// SPDX-License-Identifier: GPL-2.0-only -/** +/* * AES routines supporting VMX instructions on the Power 8 * * Copyright (C) 2015 International Business Machines Inc.
drivers/crypto/vmx/aes_cbc.c +1 -1
@@ -1,5 +1,5 @@// SPDX-License-Identifier: GPL-2.0-only -/** +/* * AES CBC routines supporting VMX instructions on the Power 8 * * Copyright (C) 2015 International Business Machines Inc.
drivers/crypto/vmx/aes_ctr.c +1 -1
@@ -1,5 +1,5 @@// SPDX-License-Identifier: GPL-2.0-only -/** +/* * AES CTR routines supporting VMX instructions on the Power 8 * * Copyright (C) 2015 International Business Machines Inc.
drivers/crypto/vmx/aes_xts.c +1 -1
@@ -1,5 +1,5 @@// SPDX-License-Identifier: GPL-2.0-only -/** +/* * AES XTS routines supporting VMX In-core instructions on Power 8 * * Copyright (C) 2015 International Business Machines Inc.
drivers/crypto/vmx/ghash.c +1 -1
@@ -1,5 +1,5 @@// SPDX-License-Identifier: GPL-2.0 -/** +/* * GHASH routines supporting VMX instructions on the Power 8 * * Copyright (C) 2015, 2019 International Business Machines Inc.
drivers/crypto/vmx/vmx.c +1 -1
@@ -1,5 +1,5 @@// SPDX-License-Identifier: GPL-2.0-only -/** +/* * Routines supporting VMX instructions on the Power 8 * * Copyright (C) 2015 International Business Machines Inc.
Signature · 6 lines
2.17.1 _______________________________________________ Linux-kernel-mentees mailing list [email protected] https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees
Quoted 91 lines · Aditya Srivastava
The opening comment mark '/**' is used for highlighting the beginning of kernel-doc comments.
There are certain files indrivers/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 commentsyntax(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.ccauses 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 <[email protected]>---
* Applies perfectly on next-20210319drivers/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(-)drivers/crypto/vmx/aes.c +1
-1@@ -1,5 +1,5 @@// SPDX-License-Identifier: GPL-2.0-only -/** +/* * AES routines supporting VMX instructions on the Power 8 * * Copyright (C) 2015 International Business Machines Inc. drivers/crypto/vmx/aes_cbc.c +1
-1@@ -1,5 +1,5 @@// SPDX-License-Identifier: GPL-2.0-only -/** +/* * AES CBC routines supporting VMX instructions on the Power 8 * * Copyright (C) 2015 International Business Machines Inc. drivers/crypto/vmx/aes_ctr.c +1
-1@@ -1,5 +1,5 @@// SPDX-License-Identifier: GPL-2.0-only -/** +/* * AES CTR routines supporting VMX instructions on the Power 8 * * Copyright (C) 2015 International Business Machines Inc. drivers/crypto/vmx/aes_xts.c +1
-1@@ -1,5 +1,5 @@// SPDX-License-Identifier: GPL-2.0-only -/** +/* * AES XTS routines supporting VMX In-core instructions on Power 8 * * Copyright (C) 2015 International Business Machines Inc. drivers/crypto/vmx/ghash.c +1
-1@@ -1,5 +1,5 @@// SPDX-License-Identifier: GPL-2.0 -/** +/* * GHASH routines supporting VMX instructions on the Power 8 * * Copyright (C) 2015, 2019 International Business Machines Inc. drivers/crypto/vmx/vmx.c +0
-0
drivers/crypto/vmx/vmx.c line 5
Quoted 6 lines
drivers/crypto/vmx/vmx.c +1
-1@@ -1,5 +1,5 @@// SPDX-License-Identifier: GPL-2.0-only -/** +/* * Routines supporting VMX instructions on the Power 8 * * Copyright (C) 2015 International Business Machines Inc.
Please excuse this mail. My --cc-cmd did not work as expected, as a result the mail wasn't sent to everyone.
I resent the patch with everyone Cc'd.
Thanks
Aditya
_______________________________________________
Linux-kernel-mentees mailing list
[email protected]
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees