]> git.ipfire.org Git - thirdparty/kernel/linux.git/commitdiff
x86/boot/Documentation: Fix htmldocs build warning due to malformed table in boot.rst
authorSwaraj Gaikwad <swarajgaikwad1925@gmail.com>
Wed, 10 Dec 2025 09:28:14 +0000 (09:28 +0000)
committerIngo Molnar <mingo@kernel.org>
Wed, 10 Dec 2025 07:34:38 +0000 (08:34 +0100)
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

index 6d36ce86fd8ec042bfb782fbcfd2c453f502243f..18574f010d46cd5c634a558090c13428aee38b11 100644 (file)
@@ -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.