Thread (14 messages) 14 messages, 5 authors, 2025-09-11

Re: [PATCH] x86/Documentation: explain LINUX_EFI_INITRD_MEDIA_GUID

From: Bagas Sanjaya <hidden>
Date: 2025-09-11 11:50:36
Also in: linux-efi, lkml

On Thu, Sep 11, 2025 at 01:22:54PM +0200, Hugo Osvaldo Barrera wrote:
On Thu, 11 Sep 2025, at 08:46, Ard Biesheuvel wrote:
quoted
On Wed, 10 Sept 2025 at 03:58, Bagas Sanjaya [off-list ref] wrote:
quoted
+.. _pe-coff-entry-point:
+
+PE/COFF entry point
+===================
+
+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.
+
This should be a link rather than a path to the source file.
I think you miss the point of Jon's comment on your original submission [1].
Long story short, in Sphinx, one would cross-reference to other documentation
files (so-called internal linking) either with :doc: or :ref: directives. In
case of kernel docs, there is third and preferred way: simply mentioning the
full docs path. The latter is preferred as it is simpler and also allows
building only portion of docs (with make SPHINXDIRS=<dir>) without triggering
any reference warnings. Hence why I did addressing his comment.
For more information, see Documentation/doc-guide/sphinx.rst.

Thanks.

[1]: https://lore.kernel.org/all/87ecx1x4su.fsf@trenco.lwn.net/ (local)

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

Attachments

Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help