[PATCH v3] Documentation: x86/boot: Fix malformed table in boot.rst

Swaraj Gaikwad posted 1 patch 3 days, 16 hours ago
Documentation/arch/x86/boot.rst | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
[PATCH v3] Documentation: x86/boot: Fix malformed table in boot.rst
Posted by Swaraj Gaikwad 3 days, 16 hours ago
Sphinx reports htmldocs warnings:

  Documentation/arch/x86/boot.rst:437: ERROR: Malformed table.
  Text in column margin in table line 2.

The table header defined the first column width as 2 characters ("=="),
which is too narrow for entries like "0x10" and "0x13". This caused the
text to spill into the margin, triggering a docutils parsing failure.

Fix it by extending the first column of assigned boot loader ID to 4
characters ("====") to fit the widest entries.

Build environment: Python 3.13.7 Sphinx 8.2.3 docutils 0.22.3

Changes in v3:
 - Minimized the diff to only change the table headers, preserving
   original indentation and body text, as suggested by Randy Dunlap.
 - No other changes

Changes in v2:
 - Dropped accidental whitespace changes (the second chunk in v1).
 - Simplified commit message as suggested by Bagas Sanjaya.

Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Tested-by: Randy Dunlap <rdunlap@infradead.org>
Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com>

Signed-off-by: Swaraj Gaikwad <swarajgaikwad1925@gmail.com>
---
 Documentation/arch/x86/boot.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/arch/x86/boot.rst b/Documentation/arch/x86/boot.rst
index 6d36ce86fd8e..18574f010d46 100644
--- a/Documentation/arch/x86/boot.rst
+++ b/Documentation/arch/x86/boot.rst
@@ -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 <hpa@zytor.com> if you need a bootloader ID value assigned.


base-commit: cb015814f8b6eebcbb8e46e111d108892c5e6821
--
2.52.0
[tip: x86/urgent] x86/boot/Documentation: Fix htmldocs build warning due to malformed table in boot.rst
Posted by tip-bot2 for Swaraj Gaikwad 3 days, 18 hours ago
The following commit has been merged into the x86/urgent branch of tip:

Commit-ID:     5288176a541215ba48d38fb74bb619e64d4d9bab
Gitweb:        https://git.kernel.org/tip/5288176a541215ba48d38fb74bb619e64d4d9bab
Author:        Swaraj Gaikwad <swarajgaikwad1925@gmail.com>
AuthorDate:    Wed, 10 Dec 2025 09:28:14 
Committer:     Ingo Molnar <mingo@kernel.org>
CommitterDate: Wed, 10 Dec 2025 08:34:38 +01:00

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

Sphinx reports htmldocs warnings:

  Documentation/arch/x86/boot.rst:437: ERROR: Malformed table.
  Text in column margin in table line 2.

The table header defined the first column width as 2 characters ("=="),
which is too narrow for entries like "0x10" and "0x13". This caused the
text to spill into the margin, triggering a docutils parsing failure.

Fix it by extending the first column of assigned boot loader ID to 4
characters ("====") to fit the widest entries.

Fixes: 1c3377bee212 ("x86/boot/Documentation: Prefix hexadecimal literals with 0x")
Tested-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Swaraj Gaikwad <swarajgaikwad1925@gmail.com>
Signed-off-by: Ingo Molnar <mingo@kernel.org>
Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com>
Link: https://patch.msgid.link/20251210092814.9986-1-swarajgaikwad1925@gmail.com
---
 Documentation/arch/x86/boot.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/arch/x86/boot.rst b/Documentation/arch/x86/boot.rst
index 6d36ce8..18574f0 100644
--- a/Documentation/arch/x86/boot.rst
+++ b/Documentation/arch/x86/boot.rst
@@ -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 <hpa@zytor.com> if you need a bootloader ID value assigned.