Skip to contentSkip to conversation

x86/sgx: Fix a W=1 build warning in function comment

PATCH Applied Kai Huang 3 participants 3 messages Aug 25, 2024 – Aug 27, 2024

Subsystems (2)
lore
Share & tools
lore

Kai Huang

author
#0 lore raw

PATCH 1/1 x86/sgx: Fix a W=1 build warning in function comment

Building the SGX code with W=1 generates below warning:

arch/x86/kernel/cpu/sgx/main.c:741: warning: Function parameter or struct member 'low' not described in 'sgx_calc_section_metric' arch/x86/kernel/cpu/sgx/main.c:741: warning: Function parameter or struct member 'high' not described in 'sgx_calc_section_metric'
...

The function sgx_calc_section_metric() is a simple helper which is only used in sgx/main.c. There's no need to use k-doc style comment for it.

Downgrade to normal comment to silence this warning.

---
 arch/x86/kernel/cpu/sgx/main.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
arch/x86/kernel/cpu/sgx/main.c +1 -1
index 27892e57c4ef..1a000acd933a 100644
@@ -732,7 +732,7 @@ int arch_memory_failure(unsigned long pfn, int flags)
 	return 0;
 }
 
-/**
+/*
  * A section metric is concatenated in a way that @low bits 12-31 define the
  * bits 12-31 of the metric and @high bits 0-19 define the bits 32-51 of the
  * metric.

base-commit: e77f8f275278886d05ce6dfe9e3bc854e7bf0713

Signature · 1 line
2.46.0
merge bot Applied
#1 lore raw
The following commit has been merged into the x86/cleanups branch of tip:

The following commit has been merged into the x86/cleanups branch of tip:

Commit-ID:     c6e6a3c1698a86bacf7eac256b0f1215a3616dc7
Gitweb:        https://git.kernel.org/tip/c6e6a3c1698a86bacf7eac256b0f1215a3616dc7
Author:        Kai Huang <[email protected]>
AuthorDate:    Sun, 25 Aug 2024 20:06:49 +12:00
Committer:     Thomas Gleixner <[email protected]>
CommitterDate: Sun, 25 Aug 2024 14:29:38 +02:00

x86/sgx: Fix a W=1 build warning in function comment

Building the SGX code with W=1 generates below warning:

arch/x86/kernel/cpu/sgx/main.c:741: warning: Function parameter or struct member 'low' not described in 'sgx_calc_section_metric' arch/x86/kernel/cpu/sgx/main.c:741: warning: Function parameter or struct member 'high' not described in 'sgx_calc_section_metric'
...

The function sgx_calc_section_metric() is a simple helper which is only used in sgx/main.c. There's no need to use kernel-doc style comment for it.

Downgrade to a normal comment.

---
 arch/x86/kernel/cpu/sgx/main.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
arch/x86/kernel/cpu/sgx/main.c +1 -1
index 27892e5..1a000ac 100644
@@ -732,7 +732,7 @@ out:
 	return 0;
 }
 
-/**
+/*
  * A section metric is concatenated in a way that @low bits 12-31 define the
  * bits 12-31 of the metric and @high bits 0-19 define the bits 32-51 of the
  * metric.
maintainer Reviewed-by on v1 1/1
#2 lore raw
In reply to Kai Huang
Quoted 30 lines · Kai Huang

Building the SGX code with W=1 generates below warning:

arch/x86/kernel/cpu/sgx/main.c:741: warning: Function parameter or struct member 'low' not described in 'sgx_calc_section_metric' arch/x86/kernel/cpu/sgx/main.c:741: warning: Function parameter or struct member 'high' not described in 'sgx_calc_section_metric'
...

The function sgx_calc_section_metric() is a simple helper which is only used in sgx/main.c. There's no need to use k-doc style comment for it.

Downgrade to normal comment to silence this warning.

---
 arch/x86/kernel/cpu/sgx/main.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
arch/x86/kernel/cpu/sgx/main.c +1 -1
index 27892e57c4ef..1a000acd933a 100644
@@ -732,7 +732,7 @@ int arch_memory_failure(unsigned long pfn, int flags)
 	return 0;
 }
 
-/**
+/*
  * A section metric is concatenated in a way that @low bits 12-31 define the
  * bits 12-31 of the metric and @high bits 0-19 define the bits 32-51 of the
  * metric.
Quoted 1 line

base-commit: e77f8f275278886d05ce6dfe9e3bc854e7bf0713

Agreed, that has went there probably by plain mistake. Do not think it has been intentional...

BR, Jarkko