mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Swaraj Gaikwad <swarajgaikwad1925@gmail.com>
To: rdunlap@infradead.org
Cc: bagasdotme@gmail.com, bp@alien8.de, corbet@lwn.net,
	dave.hansen@linux.intel.com, david.hunter.linux@gmail.com,
	hpa@zytor.com, linux-doc@vger.kernel.org,
	linux-kernel@vger.kernel.org, mingo@kernel.org, mingo@redhat.com,
	skhan@linuxfoundation.org, swarajgaikwad1925@gmail.com,
	tglx@linutronix.de, x86@kernel.org
Subject: [PATCH v3] Documentation: x86/boot: Fix malformed table in boot.rst
Date: Wed, 10 Dec 2025 09:28:14 +0000	[thread overview]
Message-ID: <20251210092814.9986-1-swarajgaikwad1925@gmail.com> (raw)
In-Reply-To: <438a873c-0ca8-43cf-b705-e224d5c57d05@infradead.org>

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


  parent reply	other threads:[~2025-12-10  3:58 UTC|newest]

Thread overview: 13+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-12-08 21:01 [PATCH] " Swaraj Gaikwad
2025-12-08 18:11 ` Randy Dunlap
2025-12-08 22:37 ` Bagas Sanjaya
2025-12-08 22:50   ` Jonathan Corbet
2025-12-08 22:58     ` Bagas Sanjaya
2025-12-09  8:53 ` [PATCH v2] " Swaraj Gaikwad
2025-12-09  8:53   ` Ingo Molnar
2025-12-09 18:15     ` Randy Dunlap
2025-12-09 21:10       ` Randy Dunlap
2025-12-09 23:17         ` Bagas Sanjaya
2025-12-10  9:28         ` Swaraj Gaikwad [this message]
2025-12-10  7:40           ` [tip: x86/urgent] x86/boot/Documentation: Fix htmldocs build warning due to " tip-bot2 for Swaraj Gaikwad
2025-12-10  1:14     ` [PATCH v2] Documentation: x86/boot: Fix " Swaraj Gaikwad

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20251210092814.9986-1-swarajgaikwad1925@gmail.com \
    --to=swarajgaikwad1925@gmail.com \
    --cc=bagasdotme@gmail.com \
    --cc=bp@alien8.de \
    --cc=corbet@lwn.net \
    --cc=dave.hansen@linux.intel.com \
    --cc=david.hunter.linux@gmail.com \
    --cc=hpa@zytor.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mingo@kernel.org \
    --cc=mingo@redhat.com \
    --cc=rdunlap@infradead.org \
    --cc=skhan@linuxfoundation.org \
    --cc=tglx@linutronix.de \
    --cc=x86@kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

all inboxes | Powered by JetHome®