Re: [PATCH] x86/init: add kernel-doc comments to x86_init.h

[Ingo Molnar]

* Randy Dunlap <rdunlap@xxxxxxxxxxxxx> wrote:

> 
> 
> On 12/1/25 12:56 PM, Ingo Molnar wrote:
> > 
> > * Randy Dunlap <rdunlap@xxxxxxxxxxxxx> 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