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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <20251210092814.9986-1-swarajgaikwad1925@gmail.com>
Date: Wed, 10 Dec 2025 09:28:14 +0000
From: Swaraj Gaikwad <swarajgaikwad1925@...il.com>
To: rdunlap@...radead.org
Cc: bagasdotme@...il.com,
	bp@...en8.de,
	corbet@....net,
	dave.hansen@...ux.intel.com,
	david.hunter.linux@...il.com,
	hpa@...or.com,
	linux-doc@...r.kernel.org,
	linux-kernel@...r.kernel.org,
	mingo@...nel.org,
	mingo@...hat.com,
	skhan@...uxfoundation.org,
	swarajgaikwad1925@...il.com,
	tglx@...utronix.de,
	x86@...nel.org
Subject: [PATCH v3] Documentation: x86/boot: Fix 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.

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@...radead.org>
Tested-by: Randy Dunlap <rdunlap@...radead.org>
Reviewed-by: Bagas Sanjaya <bagasdotme@...il.com>

Signed-off-by: Swaraj Gaikwad <swarajgaikwad1925@...il.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@...or.com> if you need a bootloader ID value assigned.


base-commit: cb015814f8b6eebcbb8e46e111d108892c5e6821
--
2.52.0