mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: "Hugo Osvaldo Barrera" <hugo@whynothugo.nl>
To: "Jonathan Corbet" <corbet@lwn.net>,
	"Bagas Sanjaya" <bagasdotme@gmail.com>,
	"Linux Kernel Mailing List" <linux-kernel@vger.kernel.org>,
	"Linux Documentation" <linux-doc@vger.kernel.org>,
	"Linux EFI" <linux-efi@vger.kernel.org>
Cc: "Ard Biesheuvel" <ardb@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>,
	"Randy Dunlap" <rdunlap@infradead.org>
Subject: Re: [PATCH v2] Documentation/x86: explain LINUX_EFI_INITRD_MEDIA_GUID
Date: Mon, 22 Sep 2025 12:51:43 +0200	[thread overview]
Message-ID: <e8bb9bb3-f9ec-49bb-9884-af727ea61caf@app.fastmail.com> (raw)
In-Reply-To: <87zfaufrcq.fsf@trenco.lwn.net>



On Tue, 16 Sep 2025, at 15:40, Jonathan Corbet wrote:
> "Hugo Osvaldo Barrera" <hugo@whynothugo.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 for the clarification.
I mis-interpreted this previously.
Sorry for the noise.


-- 
Hugo

      parent reply	other threads:[~2025-09-22 10:52 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-09-16  7:32 Bagas Sanjaya
2025-09-16  8:54 ` Hugo Osvaldo Barrera
2025-09-16 13:40   ` Jonathan Corbet
2025-09-16 14:26     ` Bagas Sanjaya
2025-09-22 10:51     ` Hugo Osvaldo Barrera [this message]

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=e8bb9bb3-f9ec-49bb-9884-af727ea61caf@app.fastmail.com \
    --to=hugo@whynothugo.nl \
    --cc=ardb@kernel.org \
    --cc=bagasdotme@gmail.com \
    --cc=bp@alien8.de \
    --cc=corbet@lwn.net \
    --cc=dave.hansen@linux.intel.com \
    --cc=hpa@zytor.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-efi@vger.kernel.org \
    --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®