Skip to contentSkip to conversation

x86/mm/mtrr: fix doc warnings in generic.c

PATCH In review Baokun Li 2 participants 2 messages Jun 5, 2021 – Jun 10, 2021 x86

lore
Share & tools
lore

Baokun Li

author
#0 lore raw

PATCH 1/1 x86/mm/mtrr: fix doc warnings in generic.c

Fixes the following W=1 kernel build warning(s):

arch/x86/kernel/cpu/mtrr/generic.c:120: warning: Function parameter or
member 'start' not described in 'mtrr_type_lookup_fixed'
arch/x86/kernel/cpu/mtrr/generic.c:120: warning: Function parameter or
member 'end' not described in 'mtrr_type_lookup_fixed'
arch/x86/kernel/cpu/mtrr/generic.c:161: warning: Function parameter or
member 'start' not described in 'mtrr_type_lookup_variable'
arch/x86/kernel/cpu/mtrr/generic.c:161: warning: Function parameter or
member 'end' not described in 'mtrr_type_lookup_variable'
arch/x86/kernel/cpu/mtrr/generic.c:161: warning: Function parameter or
member 'partial_end' not described in 'mtrr_type_lookup_variable'
arch/x86/kernel/cpu/mtrr/generic.c:161: warning: Function parameter or
member 'repeat' not described in 'mtrr_type_lookup_variable'
arch/x86/kernel/cpu/mtrr/generic.c:161: warning: Function parameter or
member 'uniform' not described in 'mtrr_type_lookup_variable'
arch/x86/kernel/cpu/mtrr/generic.c:255: warning: Function parameter or
member 'start' not described in 'mtrr_type_lookup'
arch/x86/kernel/cpu/mtrr/generic.c:255: warning: Function parameter or
member 'end' not described in 'mtrr_type_lookup'
arch/x86/kernel/cpu/mtrr/generic.c:255: warning: Function parameter or
member 'uniform' not described in 'mtrr_type_lookup'

---
 arch/x86/kernel/cpu/mtrr/generic.c | 13 ++++++++++---
 1 file changed, 10 insertions(+), 3 deletions(-)
arch/x86/kernel/cpu/mtrr/generic.c +10 -3
index 558108296f3c..8a943a83845e 100644
@@ -104,7 +104,8 @@ static int check_type_overlap(u8 *prev, u8 *curr)
 
 /**
  * mtrr_type_lookup_fixed - look up memory type in MTRR fixed entries
- *
+ * @start: Start addaress.
+ * @end: End address.
  * Return the MTRR fixed memory type of 'start'.
  *
  * MTRR fixed entries are divided into the following ways:
@@ -143,7 +144,11 @@ static u8 mtrr_type_lookup_fixed(u64 start, u64 end)
 
 /**
  * mtrr_type_lookup_variable - look up memory type in MTRR variable entries
- *
+ * @start: Start addaress.
+ * @end: End address.
+ * @partial_end: Partial end address.
+ * @repeat: Memory is repeat or not.
+ * @uniform: Memory is uniform or not.
  * Return Value:
  * MTRR_TYPE_(type) - Matched memory type or default memory type (unmatched)
  *
@@ -241,7 +246,9 @@ static u8 mtrr_type_lookup_variable(u64 start, u64 end, u64 *partial_end,
 
 /**
  * mtrr_type_lookup - look up memory type in MTRR
- *
+ * @start: Start addaress.
+ * @end: End address.
+ * @uniform: Memory is uniform or not.
  * Return Values:
  * MTRR_TYPE_(type)  - The effective MTRR type for the region
  * MTRR_TYPE_INVALID - MTRR is disabled
Signature · 1 line
2.31.1
maintainer
#1 lore raw

arch/x86/kernel/cpu/mtrr/generic.c static int check_type_overlap(u8 *prev, u8 *curr) · line 107

Quoted 6 lines · Baokun Li
arch/x86/kernel/cpu/mtrr/generic.c +1 -1
@@ -104,7 +104,8 @@ static int check_type_overlap(u8 *prev, u8 *curr)
 
 /**
  * mtrr_type_lookup_fixed - look up memory type in MTRR fixed entries
- *
+ * @start: Start addaress.

addaress?

Spellchecker?

arch/x86/kernel/cpu/mtrr/generic.c static u8 mtrr_type_lookup_fixed(u64 start, u64 end) · line 147

Quoted 10 lines
arch/x86/kernel/cpu/mtrr/generic.c +2 -1
+ * @end: End address.
  * Return the MTRR fixed memory type of 'start'.
  *
  * MTRR fixed entries are divided into the following ways:
@@ -143,7 +144,11 @@ static u8 mtrr_type_lookup_fixed(u64 start, u64 end)
 
 /**
  * mtrr_type_lookup_variable - look up memory type in MTRR variable entries
- *
+ * @start: Start addaress.

addaress?

Spellchecker?

arch/x86/kernel/cpu/mtrr/generic.c static u8 mtrr_type_lookup_fixed(u64 start, u64 end) · line 151

Quoted 4 lines
arch/x86/kernel/cpu/mtrr/generic.c +4 -0
+ * @end: End address.
+ * @partial_end: Partial end address.
+ * @repeat: Memory is repeat or not.
+ * @uniform: Memory is uniform or not.

Did you actually read that whole comment to see that maybe "repeat" and "uniform" are explained a bit further down or are you blindly "fixing" warnings just so that the tool shuts up?

Signature · 4 lines
Regards/Gruss,
    Boris.

https://people.kernel.org/tglx/notes-about-netiquette