mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Ingo Molnar <mingo@kernel.org>
To: Randy Dunlap <rdunlap@infradead.org>
Cc: linux-kernel@vger.kernel.org,
	Thomas Gleixner <tglx@linutronix.de>,
	Ingo Molnar <mingo@redhat.com>, Borislav Petkov <bp@alien8.de>,
	Dave Hansen <dave.hansen@linux.intel.com>,
	x86@kernel.org, "H. Peter Anvin" <hpa@zytor.com>
Subject: Re: [PATCH] x86/init: add kernel-doc comments to x86_init.h
Date: Mon, 1 Dec 2025 22:00:26 +0100	[thread overview]
Message-ID: <aS4B6vEx5Fjbtm93@gmail.com> (raw)
In-Reply-To: <54feefff-084b-433d-a8b7-bc8c851c7636@infradead.org>


* Randy Dunlap <rdunlap@infradead.org> wrote:

> 
> 
> On 12/1/25 12:56 PM, Ingo Molnar wrote:
> > 
> > * Randy Dunlap <rdunlap@infradead.org> wrote:
> > 
> >>   * @i8042: indicated if we expect the device to have i8042 controller
> >>   *	present.
> >>   * @rtc: this device has a CMOS real-time clock present
> >> + * @warm_reset: %1 if platform allows warm reset, else %0
> >> + * @no_vga: %1 if (FADT.boot_flags & ACPI_FADT_NO_VGA) is set, else %0
> >>   * @reserve_bios_regions: boot code will search for the EBDA address and the
> >>   * 	start of the 640k - 1M BIOS region.  If false, the platform must
> >>   * 	ensure that its memory map correctly reserves sub-1MB regions as needed.
> > 
> > What is '%1' and '%0' - literal 1 and 0?
> 
> Yes, kernel-doc notation.

Yeah, so it's not a very widespread usage versus using 
the literals. I'd go with the plain text literals, 
especially since they don't cause comment-reading 
exceptions for the brain, which is always a plus. :)

> > That's a really weird way to write them.
> 
> OK, they can be removed. Do you want a v2?

No need, I already edited it, just wanted to make sure 
I haven't missed anything.

Thanks,

	Ingo

  reply	other threads:[~2025-12-01 21:00 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-11-29  0:25 Randy Dunlap
2025-12-01 20:56 ` Ingo Molnar
2025-12-01 20:57   ` Randy Dunlap
2025-12-01 21:00     ` Ingo Molnar [this message]
2025-12-01 21:02       ` Randy Dunlap
2025-12-01 21:05 ` [tip: x86/urgent] x86/platform: Fix and extend kernel-doc comments in <asm/x86_init.h> tip-bot2 for Randy Dunlap

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=aS4B6vEx5Fjbtm93@gmail.com \
    --to=mingo@kernel.org \
    --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=rdunlap@infradead.org \
    --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®