Skip to contentSkip to conversation

docs: x86: fix malformed table in boot protocol doc

PATCH In review Daisuke Iwasa 2 participants 3 messages Jan 8

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 docs: x86: fix malformed table in boot protocol doc

Sphinx reports a malformed table warning in
Documentation/arch/x86/boot.rst.

Rewrite the "Assigned boot loader IDs" table using a simple table format so the multi-line entries are properly represented.

---
 Documentation/arch/x86/boot.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
Documentation/arch/x86/boot.rst +2 -2
index 6d36ce86fd8e..18574f010d46 100644
@@ -433,7 +433,7 @@ Protocol:	2.00+
 
   Assigned boot loader IDs:
 
-	== =======================================
+	==== =======================================
 	0x0  LILO
 	     (0x00 reserved for pre-2.00 bootloader)
 	0x1  Loadlin
@@ -456,7 +456,7 @@ Protocol:	2.00+
 	     <http://sebastian-plotz.blogspot.de>
 	0x12 OVMF UEFI virtualization stack
 	0x13 barebox
-	== =======================================
+	==== =======================================
 
   Please contact <[email protected]> if you need a bootloader ID value assigned.
 
Signature · 1 line
2.34.1
reviewer
#1 lore raw

Hi,

Quoted 25 lines · Daisuke Iwasa

Sphinx reports a malformed table warning in
Documentation/arch/x86/boot.rst.

Rewrite the "Assigned boot loader IDs" table using a simple table format so the multi-line entries are properly represented.

---
 Documentation/arch/x86/boot.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
Documentation/arch/x86/boot.rst +1 -1
index 6d36ce86fd8e..18574f010d46 100644
@@ -433,7 +433,7 @@ Protocol:	2.00+
 
   Assigned boot loader IDs:
 
-	== =======================================
+	==== =======================================
 	0x0  LILO
 	     (0x00 reserved for pre-2.00 bootloader)
 	0x1  Loadlin

Documentation/arch/x86/boot.rst Protocol: 2.00+ · line 461

Quoted 7 lines
Documentation/arch/x86/boot.rst +1 -1
@@ -456,7 +456,7 @@ Protocol:	2.00+
 	     <http://sebastian-plotz.blogspot.de>
 	0x12 OVMF UEFI virtualization stack
 	0x13 barebox
-	== =======================================
+	==== =======================================
 
   Please contact <[email protected]> if you need a bootloader ID value assigned.

That looks good, but this has already been fixed:
commit 5288176a5412

Author: Swaraj Gaikwad <[email protected]>
Date:   Wed Dec 10 09:28:14 2025 +0000

x86/boot/Documentation: Fix htmldocs build warning due to malformed table in boot.rst

Be sure to use an up-to-date kernel source tree when making & posting patches.

thanks.

Signature · 1 line
~Randy
author
#2 lore raw

Thanks for the heads-up.

I missed that commit. I’ll update my tree and look for another docs issue to work on. Sorry for the noise.

Quoted 5 lines · Randy Dunlap

That looks good, but this has already been fixed:
commit 5288176a5412

Be sure to use an up-to-date kernel source tree when making & posting patches.