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

[Randy Dunlap <rdunlap@infradead.org>]

Hi,

On 12/8/25 1:01 PM, Swaraj Gaikwad wrote:
> Building the documentation with make htmldocs previously failed with the
> following error, causing the "Assigned boot loader IDs" table to not
> render at all in the HTML output:
> 
>   Documentation/arch/x86/boot.rst:437: ERROR: Malformed table.
>   Text in column margin in table line 2.
> 
> This occurred because the ReStructuredText (RST) simple table header
> defined the first column width as 2 characters (==), which is too narrow
> for data entries like 0x10 and 0x13. This dimensional mismatch caused
> the text to spill into the margin, triggering a docutils parsing
> failure.
> This patch fixes the issue by expanding the column width in the table
> header to 4 characters (====) to correctly accommodate the widest
> entries and alignment. After applying this patch, the documentation builds
> successfully and the "Assigned boot loader IDs" table now displays
> correctly in the generated HTML.
> 
> Build environment: Python 3.13.7 Sphinx 8.2.3 docutils 0.22.3
> 
> Signed-off-by: Swaraj Gaikwad <swarajgaikwad1925@gmail.com>

Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Tested-by: Randy Dunlap <rdunlap@infradead.org>

The second chunk does not apply cleanly. It was apparently
supposed to be deleting some trailing spaces, but somewhere
those trailing spaces were dropped. And that's not described
in the patch description, so I suggest that you or anyone who
applies this patch just drop the second chunk.


Thanks.

> ---
>  Documentation/arch/x86/boot.rst | 50 ++++++++++++++++-----------------
>  1 file changed, 25 insertions(+), 25 deletions(-)
> 
> diff --git a/Documentation/arch/x86/boot.rst b/Documentation/arch/x86/boot.rst
> index 6d36ce86fd8e..99b42e9d0e1c 100644
> --- a/Documentation/arch/x86/boot.rst
> +++ b/Documentation/arch/x86/boot.rst
> @@ -433,30 +433,30 @@ Protocol:	2.00+
> 
>    Assigned boot loader IDs:
> 
> -	== =======================================
> -	0x0  LILO
> -	     (0x00 reserved for pre-2.00 bootloader)
> -	0x1  Loadlin
> -	0x2  bootsect-loader
> -	     (0x20, all other values reserved)
> -	0x3  Syslinux
> -	0x4  Etherboot/gPXE/iPXE
> -	0x5  ELILO
> -	0x7  GRUB
> -	0x8  U-Boot
> -	0x9  Xen
> -	0xA  Gujin
> -	0xB  Qemu
> -	0xC  Arcturus Networks uCbootloader
> -	0xD  kexec-tools
> -	0xE  Extended (see ext_loader_type)
> -	0xF  Special (0xFF = undefined)
> -	0x10 Reserved
> -	0x11 Minimal Linux Bootloader
> -	     <http://sebastian-plotz.blogspot.de>
> -	0x12 OVMF UEFI virtualization stack
> -	0x13 barebox
> -	== =======================================
> +==== ==============================
> +0x0  LILO
> +      (0x00 reserved for pre-2.00 bootloader)
> +0x1  Loadlin
> +0x2  bootsect-loader
> +      (0x20, all other values reserved)
> +0x3  Syslinux
> +0x4  Etherboot/gPXE/iPXE
> +0x5  ELILO
> +0x7  GRUB
> +0x8  U-Boot
> +0x9  Xen
> +0xA  Gujin
> +0xB  Qemu
> +0xC  Arcturus Networks uCbootloader
> +0xD  kexec-tools
> +0xE  Extended (see ext_loader_type)
> +0xF  Special (0xFF = undefined)
> +0x10 Reserved
> +0x11 Minimal Linux Bootloader
> +      <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.
> 
> @@ -814,7 +814,7 @@ Protocol:	2.09+
>     	__u32 len;
>     	__u8 data[];
>     }
> -
> +
>    Where, the next is a 64-bit physical pointer to the next node of
>    linked list, the next field of the last node is 0; the type is used
>    to identify the contents of data; the len is the length of data
> --
> 2.52.0
> 
> 

-- 
~Randy