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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <20191209161340.kdsikc2hvbhmpi6k@tomti.i.net-space.pl>
Date:   Mon, 9 Dec 2019 17:13:40 +0100
From:   Daniel Kiper <daniel.kiper@...cle.com>
To:     Randy Dunlap <rdunlap@...radead.org>
Cc:     LKML <linux-kernel@...r.kernel.org>, X86 ML <x86@...nel.org>,
        Jonathan Corbet <corbet@....net>,
        "linux-doc@...r.kernel.org" <linux-doc@...r.kernel.org>,
        Thomas Gleixner <tglx@...utronix.de>,
        Ingo Molnar <mingo@...hat.com>, Borislav Petkov <bp@...en8.de>,
        "H. Peter Anvin" <hpa@...or.com>
Subject: Re: [PATCH] Documentation: x86: fix boot.rst warning and format

On Sun, Dec 08, 2019 at 08:25:10PM -0800, Randy Dunlap wrote:
> From: Randy Dunlap <rdunlap@...radead.org>
>
> 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@...radead.org>
> Cc: Jonathan Corbet <corbet@....net>
> Cc: linux-doc@...r.kernel.org
> Cc: Thomas Gleixner <tglx@...utronix.de>
> Cc: Ingo Molnar <mingo@...hat.com>
> Cc: Borislav Petkov <bp@...en8.de>
> Cc: "H. Peter Anvin" <hpa@...or.com>
> Cc: x86@...nel.org
> Cc: Daniel Kiper <daniel.kiper@...cle.com>

Reviewed-by: Daniel Kiper <daniel.kiper@...cle.com>

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.

Daniel