[PATCH 0/2] x86/cpu: Fix kernel-doc warnings

[PATCH 0/2] x86/cpu: Fix kernel-doc warnings

[Kael D'Alcamo]

Fix the following kernel-doc warnings found by `make W=1`:

Warning: arch/x86/kernel/cpu/mtrr/amd.c:60 function parameter 'reg' not described in 'amd_set_mtrr'
Warning: arch/x86/kernel/cpu/mtrr/amd.c:60 function parameter 'base' not described in 'amd_set_mtrr'
Warning: arch/x86/kernel/cpu/mtrr/amd.c:60 function parameter 'size' not described in 'amd_set_mtrr'
Warning: arch/x86/kernel/cpu/mtrr/amd.c:60 function parameter 'type' not described in 'amd_set_mtrr'
Warning: arch/x86/kernel/cpu/mtrr/centaur.c:27 function parameter 'replace_reg' not described in 'centaur_get_free_region'

Kael D'Alcamo (2):
  x86/cpu: Fix kernel-doc for 'amd_set_mtrr'
  x86/cpu: Fix kernel-doc for 'centaur_get_free_region'

 arch/x86/kernel/cpu/mtrr/amd.c     | 8 ++++----
 arch/x86/kernel/cpu/mtrr/centaur.c | 1 +
 2 files changed, 5 insertions(+), 4 deletions(-)

-- 
2.51.0

[PATCH 1/2] x86/cpu: Fix kernel-doc for 'amd_set_mtrr'

[Kael D'Alcamo]

Signed-off-by: Kael D'Alcamo <dev@kael-k.io>
---
 arch/x86/kernel/cpu/mtrr/amd.c | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/arch/x86/kernel/cpu/mtrr/amd.c b/arch/x86/kernel/cpu/mtrr/amd.c
index ef3e8e42b782..02508a0a1a04 100644
--- a/arch/x86/kernel/cpu/mtrr/amd.c
+++ b/arch/x86/kernel/cpu/mtrr/amd.c
@@ -49,10 +49,10 @@ amd_get_mtrr(unsigned int reg, unsigned long *base,
 /**
  * amd_set_mtrr - Set variable MTRR register on the local CPU.
  *
- * @reg The register to set.
- * @base The base address of the region.
- * @size The size of the region. If this is 0 the region is disabled.
- * @type The type of the region.
+ * @reg: The register to set.
+ * @base: The base address of the region.
+ * @size: The size of the region. If this is 0 the region is disabled.
+ * @type: The type of the region.
  *
  * Returns nothing.
  */
-- 
2.51.0

[PATCH 2/2] x86/cpu: Fix kernel-doc for 'centaur_get_free_region'

[Kael D'Alcamo]

Signed-off-by: Kael D'Alcamo <dev@kael-k.io>
---
 arch/x86/kernel/cpu/mtrr/centaur.c | 1 +
 1 file changed, 1 insertion(+)

diff --git a/arch/x86/kernel/cpu/mtrr/centaur.c b/arch/x86/kernel/cpu/mtrr/centaur.c
index 6f6c3ae92943..f4c72402c284 100644
--- a/arch/x86/kernel/cpu/mtrr/centaur.c
+++ b/arch/x86/kernel/cpu/mtrr/centaur.c
@@ -20,6 +20,7 @@ static u8 centaur_mcr_type;	/* 0 for winchip, 1 for winchip2 */
  *
  * @base: The starting (base) address of the region.
  * @size: The size (in bytes) of the region.
+ * @replace_reg: mtrr index to be replaced; set to invalid value if none.
  *
  * Returns: the index of the region on success, else -1 on error.
  */
-- 
2.51.0

Re: [PATCH 2/2] x86/cpu: Fix kernel-doc for 'centaur_get_free_region'

[Borislav Petkov]

On Sun, Oct 05, 2025 at 10:41:21PM +0200, Kael D'Alcamo wrote:
> Signed-off-by: Kael D'Alcamo <dev@kael-k.io>
> ---
>  arch/x86/kernel/cpu/mtrr/centaur.c | 1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git a/arch/x86/kernel/cpu/mtrr/centaur.c b/arch/x86/kernel/cpu/mtrr/centaur.c
> index 6f6c3ae92943..f4c72402c284 100644
> --- a/arch/x86/kernel/cpu/mtrr/centaur.c
> +++ b/arch/x86/kernel/cpu/mtrr/centaur.c
> @@ -20,6 +20,7 @@ static u8 centaur_mcr_type;	/* 0 for winchip, 1 for winchip2 */
>   *
>   * @base: The starting (base) address of the region.
>   * @size: The size (in bytes) of the region.
> + * @replace_reg: mtrr index to be replaced; set to invalid value if none.

I'm afraid I can't follow here what invalid value you mean...

In any case, pls merge those two into a single patch and make sure it has
a commit message.

Thx.

-- 
Regards/Gruss,
    Boris.

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

[PATCH v2 0/1] x86/mtrr: Fix kernel-doc warnings in amd.c and centaur.c

[Kael D'Alcamo]

Hi Boris,

Thank you for your feedback

>> Signed-off-by: Kael D'Alcamo <dev@kael-k.io>
>> ---
>>  arch/x86/kernel/cpu/mtrr/centaur.c | 1 +
>>  1 file changed, 1 insertion(+)
>> 
>> diff --git a/arch/x86/kernel/cpu/mtrr/centaur.c b/arch/x86/kernel/cpu/mtrr/centaur.c
>> index 6f6c3ae92943..f4c72402c284 100644
>> --- a/arch/x86/kernel/cpu/mtrr/centaur.c
>> +++ b/arch/x86/kernel/cpu/mtrr/centaur.c
>> @@ -20,6 +20,7 @@ static u8 centaur_mcr_type;	/* 0 for winchip, 1 for winchip2 */
>>   *
>>   * @base: The starting (base) address of the region.
>>   * @size: The size (in bytes) of the region.
>> + * @replace_reg: mtrr index to be replaced; set to invalid value if none.
>
>I'm afraid I can't follow here what invalid value you mean...

In order to solve the warning issue while keeping the documentation
homogeneus, I used the same description from the get_free_region in
generic.c.
I believe that the original doc author referred to the fact that you can either
choose to reuse a specific MTRR (by passing its index in replace_reg) 
or ask the function to find a free one
by passing an "invalid value" (for instance -1).

Changelog v1 -> v2:
* merge changes into a single patch
* add commit message

Have a nice day,
Kael.

Kael D'Alcamo (1):
  x86/mtrr: Fix kernel-doc warnings in amd.c and centaur.c

 arch/x86/kernel/cpu/mtrr/amd.c     | 8 ++++----
 arch/x86/kernel/cpu/mtrr/centaur.c | 1 +
 2 files changed, 5 insertions(+), 4 deletions(-)

-- 
2.51.1

[PATCH v2 1/1] x86/mtrr: Fix kernel-doc warnings in amd.c and centaur.c

[Kael D'Alcamo]

Fix kernel-doc issues in amd.c and centaur.c that triggered warnings when
building with `W=1`

Signed-off-by: Kael D'Alcamo <dev@kael-k.io>
---
 arch/x86/kernel/cpu/mtrr/amd.c     | 8 ++++----
 arch/x86/kernel/cpu/mtrr/centaur.c | 1 +
 2 files changed, 5 insertions(+), 4 deletions(-)

diff --git a/arch/x86/kernel/cpu/mtrr/amd.c b/arch/x86/kernel/cpu/mtrr/amd.c
index ef3e8e42b782..02508a0a1a04 100644
--- a/arch/x86/kernel/cpu/mtrr/amd.c
+++ b/arch/x86/kernel/cpu/mtrr/amd.c
@@ -49,10 +49,10 @@ amd_get_mtrr(unsigned int reg, unsigned long *base,
 /**
  * amd_set_mtrr - Set variable MTRR register on the local CPU.
  *
- * @reg The register to set.
- * @base The base address of the region.
- * @size The size of the region. If this is 0 the region is disabled.
- * @type The type of the region.
+ * @reg: The register to set.
+ * @base: The base address of the region.
+ * @size: The size of the region. If this is 0 the region is disabled.
+ * @type: The type of the region.
  *
  * Returns nothing.
  */
diff --git a/arch/x86/kernel/cpu/mtrr/centaur.c b/arch/x86/kernel/cpu/mtrr/centaur.c
index 6f6c3ae92943..f4c72402c284 100644
--- a/arch/x86/kernel/cpu/mtrr/centaur.c
+++ b/arch/x86/kernel/cpu/mtrr/centaur.c
@@ -20,6 +20,7 @@ static u8 centaur_mcr_type;	/* 0 for winchip, 1 for winchip2 */
  *
  * @base: The starting (base) address of the region.
  * @size: The size (in bytes) of the region.
+ * @replace_reg: mtrr index to be replaced; set to invalid value if none.
  *
  * Returns: the index of the region on success, else -1 on error.
  */
-- 
2.51.1