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

[Randy Dunlap <rdunlap@infradead.org>]

On 12/9/25 12:53 AM, Ingo Molnar wrote:
> * Swaraj Gaikwad <swarajgaikwad1925@gmail.com> wrote:
> 
>> 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.
>>
>> 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>
>> ---
>> Changes in v2:
>>  - Dropped accidental whitespace changes (the second chunk in v1).
>>  - Simplified commit message as suggested by Bagas Sanjaya.
>>
>> ---
>>  Documentation/arch/x86/boot.rst | 48 ++++++++++++++++-----------------
>>  1 file changed, 24 insertions(+), 24 deletions(-)
>>
>> diff --git a/Documentation/arch/x86/boot.rst b/Documentation/arch/x86/boot.rst
>> index 6d36ce86fd8e..89e785850f7e 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
>> +==== ==============================
> 
> So why was the leading tab dropped and why wasn't this change,
> unnecessary to the bug fix in question, declared in the changelog?

Hi Ingo,

It makes no difference to the generated html output, but for users
who read Documentation/* files in place, the leading tab indentation
looks a little nicer IMO. Yes?

Thanks for noticing.
-- 
~Randy