1. Patchew
  2. linux
  3. View series

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

Swaraj Gaikwad posted 1 patch 2 months ago
There is a newer version of this series
Documentation/arch/x86/boot.rst | 48 ++++++++++++++++-----------------
1 file changed, 24 insertions(+), 24 deletions(-)
[PATCH v2] Documentation: x86/boot: Fix malformed table in boot.rst
Posted by Swaraj Gaikwad 2 months ago 
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
+==== ==============================

   Please contact <hpa@zytor.com> if you need a bootloader ID value assigned.

--
2.52.0
Re: [PATCH v2] Documentation: x86/boot: Fix malformed table in boot.rst
Posted by Ingo Molnar 2 months ago 
* 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?

Thanks,

	Ingo
Re: [PATCH v2] Documentation: x86/boot: Fix malformed table in boot.rst
Posted by Swaraj Gaikwad 1 month, 4 weeks ago 
Hi Ingo,

I dropped the leading tab/indentation because I noticed that most
other tables in this file (boot.rst) are left-aligned without indentation.
I thought it would be better to align this table with the rest of the
document style while applying the width fix.

However, if the preference is to preserve the original indentation
to keep the diff minimal and focused solely on the table width fix, I am
happy to send a v3 that restores the leading tabs.

Please let me know if you would prefer I revert the indentation change.

Thanks,
Swaraj
Re: [PATCH v2] Documentation: x86/boot: Fix malformed table in boot.rst
Posted by Randy Dunlap 1 month, 4 weeks ago 

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
Re: [PATCH v2] Documentation: x86/boot: Fix malformed table in boot.rst
Posted by Randy Dunlap 1 month, 4 weeks ago 

On 12/9/25 10:15 AM, Randy Dunlap wrote:
> 
> 
> 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.

FWIW, I would have done it like this:

---
 Documentation/arch/x86/boot.rst |    4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

--- linux-next-20251205.orig/Documentation/arch/x86/boot.rst
+++ linux-next-20251205/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.
 


-- 
~Randy
Re: [PATCH v2] Documentation: x86/boot: Fix malformed table in boot.rst
Posted by Bagas Sanjaya 1 month, 4 weeks ago 
On Tue, Dec 09, 2025 at 01:10:41PM -0800, Randy Dunlap wrote:
> FWIW, I would have done it like this:
> 
> ---
>  Documentation/arch/x86/boot.rst |    4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> --- linux-next-20251205.orig/Documentation/arch/x86/boot.rst
> +++ linux-next-20251205/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 one looks nicer.

Thanks.

-- 
An old man doll... just what I always wanted! - Clara
[PATCH v3] Documentation: x86/boot: Fix malformed table in boot.rst
Posted by Swaraj Gaikwad 1 month, 4 weeks ago 
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
[tip: x86/urgent] x86/boot/Documentation: Fix htmldocs build warning due to malformed table in boot.rst
Posted by tip-bot2 for Swaraj Gaikwad 1 month, 4 weeks ago 
The following commit has been merged into the x86/urgent branch of tip:

Commit-ID:     5288176a541215ba48d38fb74bb619e64d4d9bab
Gitweb:        https://git.kernel.org/tip/5288176a541215ba48d38fb74bb619e64d4d9bab
Author:        Swaraj Gaikwad <swarajgaikwad1925@gmail.com>
AuthorDate:    Wed, 10 Dec 2025 09:28:14 
Committer:     Ingo Molnar <mingo@kernel.org>
CommitterDate: Wed, 10 Dec 2025 08:34:38 +01:00

x86/boot/Documentation: Fix htmldocs build warning due to malformed table in boot.rst

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.

Fixes: 1c3377bee212 ("x86/boot/Documentation: Prefix hexadecimal literals with 0x")
Tested-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Swaraj Gaikwad <swarajgaikwad1925@gmail.com>
Signed-off-by: Ingo Molnar <mingo@kernel.org>
Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com>
Link: https://patch.msgid.link/20251210092814.9986-1-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 6d36ce8..18574f0 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.

Patchew 2.1-devel-b67e4c2

© 2016 - 2026 Red Hat, Inc.