mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Kael D'Alcamo <dev@kael-k.io>
To: Thomas Gleixner <tglx@linutronix.de>,
	Ingo Molnar <mingo@redhat.com>, Borislav Petkov <bp@alien8.de>,
	Dave Hansen <dave.hansen@linux.intel.com>
Cc: x86@kernel.org, "H. Peter Anvin" <hpa@zytor.com>,
	linux-kernel@vger.kernel.org
Subject: [PATCH v2 0/1] x86/mtrr: Fix kernel-doc warnings in amd.c and centaur.c
Date: Sun, 26 Oct 2025 20:54:41 +0100	[thread overview]
Message-ID: <20251026195511.79300-1-dev@kael-k.io> (raw)
In-Reply-To: <20251021103739.GBaPdic1JTakX2bA9i@fat_crate.local>

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


  reply	other threads:[~2025-10-26 19:55 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-10-05 20:41 [PATCH 0/2] x86/cpu: Fix kernel-doc warnings Kael D'Alcamo
2025-10-05 20:41 ` [PATCH 1/2] x86/cpu: Fix kernel-doc for 'amd_set_mtrr' Kael D'Alcamo
2025-10-05 20:41 ` [PATCH 2/2] x86/cpu: Fix kernel-doc for 'centaur_get_free_region' Kael D'Alcamo
2025-10-21 10:37   ` Borislav Petkov
2025-10-26 19:54     ` Kael D'Alcamo [this message]
2025-10-26 19:54       ` [PATCH v2 1/1] x86/mtrr: Fix kernel-doc warnings in amd.c and centaur.c Kael D'Alcamo

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20251026195511.79300-1-dev@kael-k.io \
    --to=dev@kael-k.io \
    --cc=bp@alien8.de \
    --cc=dave.hansen@linux.intel.com \
    --cc=hpa@zytor.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mingo@redhat.com \
    --cc=tglx@linutronix.de \
    --cc=x86@kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

all inboxes | Powered by JetHome®