Re: [PATCH v2] Documentation/x86: explain LINUX_EFI_INITRD_MEDIA_GUID

[Bagas Sanjaya]

On Tue, Sep 16, 2025 at 07:40:21AM -0600, Jonathan Corbet wrote:
> "Hugo Osvaldo Barrera" <hugo@xxxxxxxxxxxxx> 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.

That's why I keep the file cross-reference...

-- 
An old man doll... just what I always wanted! - Clara

Attachment: signature.asc
Description: PGP signature