linux-kernel - Re: [PATCH v2] Documentation/x86: explain LINUX_EFI_INITRD_MEDIA

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 for Android: free password hash cracker in your pocket

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

Message-ID: <87zfaufrcq.fsf@trenco.lwn.net>
Date: Tue, 16 Sep 2025 07:40:21 -0600
From: Jonathan Corbet <corbet@....net>
To: Hugo Osvaldo Barrera <hugo@...nothugo.nl>, Bagas Sanjaya
 <bagasdotme@...il.com>, Linux Kernel Mailing List
 <linux-kernel@...r.kernel.org>, Linux Documentation
 <linux-doc@...r.kernel.org>, Linux EFI <linux-efi@...r.kernel.org>
Cc: Ard Biesheuvel <ardb@...nel.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>, Randy Dunlap <rdunlap@...radead.org>
Subject: Re: [PATCH v2] Documentation/x86: explain LINUX_EFI_INITRD_MEDIA_GUID

"Hugo Osvaldo Barrera" <hugo@...nothugo.nl> writes:

>> +When compiled with ``CONFIG_EFI_STUB=y``, the kernel can be executed 
>> as a
>> +regular PE/COFF binary. See Documentation/admin-guide/efi-stub.rst for
>> +implementation details.
>
> I must insist that it's a terrible idea to replace an actual link with the
> name of the source file.
>
> This might be (marginally) more convenient for somebody who's editing the
> documentation, but it becomes completely useless for somebody who's READING
> the documentation. Documentation needs to target readers.
>
> For someone reading https://www.kernel.org/doc/html/latest/arch/x86/boot.html,
> the above filename conveys no useful information.

When the documentation is rendered into HTML, that file reference will
be turned into a link automatically, and people reading it on kernel.org
will not notice the difference.

Thanks,

jon