From: Bagas Sanjaya <bagasdotme@gmail.com>
To: Linux Kernel Mailing List <linux-kernel@vger.kernel.org>,
Linux Documentation <linux-doc@vger.kernel.org>
Cc: 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>,
Jonathan Corbet <corbet@lwn.net>,
Ross Philipson <ross.philipson@oracle.com>,
Daniel Kiper <daniel.kiper@oracle.com>,
Konrad Rzeszutek Wilk <konrad.wilk@oracle.com>,
Ard Biesheuvel <ardb@kernel.org>,
Bagas Sanjaya <bagasdotme@gmail.com>
Subject: [PATCH 2/2] Documentation: x86: Wrap EFI handover deprecation in note block
Date: Mon, 6 Nov 2023 17:12:05 +0700 [thread overview]
Message-ID: <20231106101206.76487-3-bagasdotme@gmail.com> (raw)
In-Reply-To: <20231106101206.76487-1-bagasdotme@gmail.com>
EFI handover protocol depreciation note is the only admonition in the
doc that is written as normal paragraph instead. Use note:: block for
that purpose.
Fixes: 8b84769a7a15 ("Documentation/x86, efi/x86: Clarify EFI handover protocol and its requirements")
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
Documentation/arch/x86/boot.rst | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)
diff --git a/Documentation/arch/x86/boot.rst b/Documentation/arch/x86/boot.rst
index 22cc7a040dae05..67cbb75cea6fdf 100644
--- a/Documentation/arch/x86/boot.rst
+++ b/Documentation/arch/x86/boot.rst
@@ -1432,7 +1432,8 @@ The boot loader *must* fill out the following fields in bp::
All other fields should be zero.
-NOTE: The EFI Handover Protocol is deprecated in favour of the ordinary PE/COFF
+.. note::
+ The EFI Handover Protocol is deprecated in favour of the ordinary PE/COFF
entry point, combined with the LINUX_EFI_INITRD_MEDIA_GUID based initrd
loading protocol (refer to [0] for an example of the bootloader side of
this), which removes the need for any knowledge on the part of the EFI
@@ -1440,4 +1441,4 @@ NOTE: The EFI Handover Protocol is deprecated in favour of the ordinary PE/COFF
requirements/limitations regarding the placement of the command line
and ramdisk in memory, or the placement of the kernel image itself.
-[0] https://github.com/u-boot/u-boot/commit/ec80b4735a593961fe701cc3a5d717d4739b0fd0
+ [0] https://github.com/u-boot/u-boot/commit/ec80b4735a593961fe701cc3a5d717d4739b0fd0
--
An old man doll... just what I always wanted! - Clara
prev parent reply other threads:[~2023-11-06 10:12 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-11-06 10:12 [PATCH 0/2] Documentation: x86: Note fixes for boot protocol doc Bagas Sanjaya
2023-11-06 10:12 ` [PATCH 1/2] Documentation: x86: Indent note directive for protocol version number note Bagas Sanjaya
2023-11-06 11:58 ` [tip: x86/urgent] x86/Documentation: Indent 'note::' " tip-bot2 for Bagas Sanjaya
2023-11-06 10:12 ` Bagas Sanjaya [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=20231106101206.76487-3-bagasdotme@gmail.com \
--to=bagasdotme@gmail.com \
--cc=ardb@kernel.org \
--cc=bp@alien8.de \
--cc=corbet@lwn.net \
--cc=daniel.kiper@oracle.com \
--cc=dave.hansen@linux.intel.com \
--cc=hpa@zytor.com \
--cc=konrad.wilk@oracle.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mingo@redhat.com \
--cc=ross.philipson@oracle.com \
--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®