Re: [PATCH] x86/sgx: fix incorrect kernel-doc comment syntax in files
From: Randy Dunlap <hidden>
Date: 2021-03-30 21:21:20
Also in:
linux-kernel-mentees, lkml
On 3/30/21 2:18 PM, Aditya Srivastava wrote:
The opening comment mark '/**' is used for highlighting the beginning of kernel-doc comments. There are certain files in arch/x86/kernel/cpu/sgx, 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 arch/x86/kernel/cpu/sgx/encl.h causes this warning: "warning: expecting prototype for 2016(). Prototype was for _X86_ENCL_H() instead" Similarly for arch/x86/kernel/cpu/sgx/arch.h too. Provide a simple fix by replacing these occurrences with general comment format, i.e. '/*', to prevent kernel-doc from parsing it. Signed-off-by: Aditya Srivastava <redacted>
Acked-by: Randy Dunlap <redacted>
quoted hunk ↗ jump to hunk
--- * Applies perfectly on next-20210326 arch/x86/kernel/cpu/sgx/arch.h | 2 +- arch/x86/kernel/cpu/sgx/encl.h | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-)diff --git a/arch/x86/kernel/cpu/sgx/arch.h b/arch/x86/kernel/cpu/sgx/arch.h index 26315bea1cb4..70b84bbdaa1d 100644 --- a/arch/x86/kernel/cpu/sgx/arch.h +++ b/arch/x86/kernel/cpu/sgx/arch.h@@ -1,5 +1,5 @@ /* SPDX-License-Identifier: GPL-2.0 */ -/** +/* * Copyright(c) 2016-20 Intel Corporation. * * Contains data structures defined by the SGX architecture. Data structuresdiff --git a/arch/x86/kernel/cpu/sgx/encl.h b/arch/x86/kernel/cpu/sgx/encl.h index d8d30ccbef4c..76b9bc1c5c30 100644 --- a/arch/x86/kernel/cpu/sgx/encl.h +++ b/arch/x86/kernel/cpu/sgx/encl.h@@ -1,5 +1,5 @@ /* SPDX-License-Identifier: GPL-2.0 */ -/** +/* * Copyright(c) 2016-20 Intel Corporation. * * Contains the software defined data structures for enclaves.
-- ~Randy