docs: x86: fix malformed table in boot protocol doc

[PATCH] docs: x86: fix malformed table in boot protocol doc

Posted by Daisuke Iwasa 1 month ago

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.

Signed-off-by: Daisuke Iwasa <iwadjp@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.
 
-- 
2.34.1

Re: [PATCH] docs: x86: fix malformed table in boot protocol doc

Posted by Randy Dunlap 1 month ago

Hi,

On 1/7/26 10:46 PM, Daisuke Iwasa wrote:
> 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.
> 
> Signed-off-by: Daisuke Iwasa <iwadjp@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.

That looks good, but this has already been fixed:
commit 5288176a5412
Author: Swaraj Gaikwad <swarajgaikwad1925@gmail.com>
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.
-- 
~Randy

Re: [PATCH] docs: x86: fix malformed table in boot protocol doc

Posted by iwadjp 4 weeks, 1 day ago

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.

On Thu, Jan 8, 2026 at 15:54, Randy Dunlap <rdunlap@infradead.org> wrote:
> 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.