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: <20191209165858.GE32169@bombadil.infradead.org>
Date:   Mon, 9 Dec 2019 08:58:58 -0800
From:   Matthew Wilcox <willy@...radead.org>
To:     Randy Dunlap <rdunlap@...radead.org>
Cc:     Daniel Kiper <daniel.kiper@...cle.com>,
        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 Mon, Dec 09, 2019 at 08:26:17AM -0800, Randy Dunlap wrote:
> On 12/9/19 8:13 AM, Daniel Kiper wrote:
> > 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.

"make W=1" will show warnings from the kernel-doc program without going to
the trouble of building the documentation.  We can enable it by default
once the number of extra warnings it produces is reduced significantly
(in November 2017 it was 1300).