Re: [PATCH] Documentation: x86: fix boot.rst warning and format

[Randy Dunlap]

On 12/9/19 8:13 AM, Daniel Kiper wrote:
> On Sun, Dec 08, 2019 at 08:25:10PM -0800, Randy Dunlap wrote:
>> From: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
>>
>> Fix a Sphinx documentation format warning by breaking a long line
>> into 2 lines.
>>
>> Also drop the ':' usage after the Protocol version numbers since
>> other Protocol versions don't use colons.
>>
>> Documentation/x86/boot.rst:72: WARNING: Malformed table.
>> Text in column margin in table line 57.
>>
>> Fixes: 2c33c27fd603 ("x86/boot: Introduce kernel_info")
>> Fixes: 00cd1c154d56 ("x86/boot: Introduce kernel_info.setup_type_max")
>> Signed-off-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
>> Cc: Jonathan Corbet <corbet@xxxxxxx>
>> Cc: linux-doc@xxxxxxxxxxxxxxx
>> Cc: Thomas Gleixner <tglx@xxxxxxxxxxxxx>
>> Cc: Ingo Molnar <mingo@xxxxxxxxxx>
>> Cc: Borislav Petkov <bp@xxxxxxxxx>
>> Cc: "H. Peter Anvin" <hpa@xxxxxxxxx>
>> Cc: x86@xxxxxxxxxx
>> Cc: Daniel Kiper <daniel.kiper@xxxxxxxxxx>
> 
> Reviewed-by: Daniel Kiper <daniel.kiper@xxxxxxxxxx>
> 
> What can I do next time to avoid mistakes like that? I suppose that
> I can run something to get this warning but I do not know what exactly
> it should be.

I just do:
$ mkdir DOC1
$ make O=DOC1 htmldocs &>doc1.out

doc1.out will contain the build log for the documentation.
It will be large.  :(
Just grep (or use editor search) for the file(s) that you are
interested in.


thanks.
-- 
~Randy