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

[Bagas Sanjaya <bagasdotme@gmail.com>]

[-- Attachment #1: Type: text/plain, Size: 3088 bytes --]

On Mon, Dec 08, 2025 at 09:01:12PM +0000, 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.

I'd like to instead write the patch description as (more concise):

```
Sphinx reports htmldocs warnings:

  Documentation/arch/x86/boot.rst:437: ERROR: Malformed table.
  Text in column margin in table line 2.

Fix it by extending the first column of assigned boot loader ID to fit
the widest entries, which are 0x10 to 0x13.
```

>    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
> +==== ==============================
> 

Aside from Randy's comment on the trailing spaces chunk, the patch LGTM.

Fixes: 1c3377bee212 ("x86/boot/Documentation: Prefix hexadecimal literals with 0x")
Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com>

x86 maintainers: please route this patch through x86/urgent branch.

Thanks.

-- 
An old man doll... just what I always wanted! - Clara

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]