linux-kernel - Re: [PATCH] x86/init: add kernel-doc comments to x86

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <cb2767dd-ab89-45df-8641-f899e7683501@infradead.org>
Date: Mon, 1 Dec 2025 13:02:03 -0800
From: Randy Dunlap <rdunlap@...radead.org>
To: Ingo Molnar <mingo@...nel.org>
Cc: linux-kernel@...r.kernel.org, Thomas Gleixner <tglx@...utronix.de>,
 Ingo Molnar <mingo@...hat.com>, Borislav Petkov <bp@...en8.de>,
 Dave Hansen <dave.hansen@...ux.intel.com>, x86@...nel.org,
 "H. Peter Anvin" <hpa@...or.com>
Subject: Re: [PATCH] x86/init: add kernel-doc comments to x86_init.h



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

Definitely.

>>> 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.

OK, thanks.

-- 
~Randy