[PATCH 0/2] Documentation: x86: Note fixes for boot protocol doc

[PATCH 0/2] Documentation: x86: Note fixes for boot protocol doc

[Bagas Sanjaya]

When I was reviewing generated html output of my web font series [1]
by viewing boot protocol doc (Documentation/output/arch/x86/boot.html),
I noticed that notes there wasn't right: the first note extended to
the end of doc; and the last one wasn't marked up as note either.

Let's fix them up.

[1]: https://lore.kernel.org/lkml/20231102120053.30630-1-bagasdotme@gmail.com/

Bagas Sanjaya (2):
  Documentation: x86: Indent note directive for protocol version number
    note
  Documentation: x86: Wrap EFI handover deprecation in note block

 Documentation/arch/x86/boot.rst | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)


base-commit: 77fa2fbe87fc605c4bfa87dff87be9bfded0e9a3
-- 
An old man doll... just what I always wanted! - Clara

[PATCH 1/2] Documentation: x86: Indent note directive for protocol version number note

[Bagas Sanjaya]

The protocol version number note is between protocol version table and
memory layout section. As such, Sphinx renders the note directive not
only on the actual note, but until the end of doc.

Indent the directive so that only the actual protocol version number
note is rendered as such.

Fixes: 2c33c27fd603 ("x86/boot: Introduce kernel_info")
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 Documentation/arch/x86/boot.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/arch/x86/boot.rst b/Documentation/arch/x86/boot.rst
index f5d2f2414de8b6..22cc7a040dae05 100644
--- a/Documentation/arch/x86/boot.rst
+++ b/Documentation/arch/x86/boot.rst
@@ -77,7 +77,7 @@ Protocol 2.14	BURNT BY INCORRECT COMMIT
 Protocol 2.15	(Kernel 5.5) Added the kernel_info and kernel_info.setup_type_max.
 =============	============================================================
 
-.. note::
+  .. note::
      The protocol version number should be changed only if the setup header
      is changed. There is no need to update the version number if boot_params
      or kernel_info are changed. Additionally, it is recommended to use
-- 
An old man doll... just what I always wanted! - Clara

[tip: x86/urgent] x86/Documentation: Indent 'note::' directive for protocol version number note

[tip-bot2 for Bagas Sanjaya]

The following commit has been merged into the x86/urgent branch of tip:

Commit-ID:     18216762bcf618c52b85719d3563243f80e4a2d4
Gitweb:        https://git.kernel.org/tip/18216762bcf618c52b85719d3563243f80e4a2d4
Author:        Bagas Sanjaya <bagasdotme@gmail.com>
AuthorDate:    Mon, 06 Nov 2023 17:12:04 +07:00
Committer:     Ingo Molnar <mingo@kernel.org>
CommitterDate: Mon, 06 Nov 2023 12:53:57 +01:00

x86/Documentation: Indent 'note::' directive for protocol version number note

The protocol version number note is between the protocol version table and
the memory layout section. As such, Sphinx renders the note directive not
only on the actual note, but until the end of doc.

Indent the directive so that only the actual protocol version number
note is rendered as such.

Fixes: 2c33c27fd603 ("x86/boot: Introduce kernel_info")
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
Signed-off-by: Ingo Molnar <mingo@kernel.org>
Cc: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20231106101206.76487-2-bagasdotme@gmail.com
Signed-off-by: Ingo Molnar <mingo@kernel.org>
---
 Documentation/arch/x86/boot.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/arch/x86/boot.rst b/Documentation/arch/x86/boot.rst
index f5d2f24..22cc7a0 100644
--- a/Documentation/arch/x86/boot.rst
+++ b/Documentation/arch/x86/boot.rst
@@ -77,7 +77,7 @@ Protocol 2.14	BURNT BY INCORRECT COMMIT
 Protocol 2.15	(Kernel 5.5) Added the kernel_info and kernel_info.setup_type_max.
 =============	============================================================
 
-.. note::
+  .. note::
      The protocol version number should be changed only if the setup header
      is changed. There is no need to update the version number if boot_params
      or kernel_info are changed. Additionally, it is recommended to use

[PATCH 2/2] Documentation: x86: Wrap EFI handover deprecation in note block

[Bagas Sanjaya]

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