Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.33 as permitted sender) client-ip=23.128.96.33;
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
Message-ID: <20231106101206.76487-3-bagasdotme@gmail.com>
In-Reply-To: <20231106101206.76487-1-bagasdotme@gmail.com>
References: <20231106101206.76487-1-bagasdotme@gmail.com>
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
Precedence: bulk

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