From: Matthew Wilcox <willy@infradead.org>
To: Randy Dunlap <rdunlap@infradead.org>
Cc: Daniel Kiper <daniel.kiper@oracle.com>,
LKML <linux-kernel@vger.kernel.org>, X86 ML <x86@kernel.org>,
Jonathan Corbet <corbet@lwn.net>,
"linux-doc@vger.kernel.org" <linux-doc@vger.kernel.org>,
Thomas Gleixner <tglx@linutronix.de>,
Ingo Molnar <mingo@redhat.com>, Borislav Petkov <bp@alien8.de>,
"H. Peter Anvin" <hpa@zytor.com>
Subject: Re: [PATCH] Documentation: x86: fix boot.rst warning and format
Date: Mon, 9 Dec 2019 08:58:58 -0800 [thread overview]
Message-ID: <20191209165858.GE32169@bombadil.infradead.org> (raw)
In-Reply-To: <a934c91b-0c9f-59d4-ee44-bcd7e9b20334@infradead.org>
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).
next prev parent reply other threads:[~2019-12-09 16:59 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-12-09 4:25 [PATCH] Documentation: x86: fix boot.rst warning and format Randy Dunlap
2019-12-09 16:13 ` Daniel Kiper
2019-12-09 16:26 ` Randy Dunlap
2019-12-09 16:58 ` Matthew Wilcox [this message]
2019-12-19 16:25 ` Jonathan Corbet
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20191209165858.GE32169@bombadil.infradead.org \
--to=willy@infradead.org \
--cc=bp@alien8.de \
--cc=corbet@lwn.net \
--cc=daniel.kiper@oracle.com \
--cc=hpa@zytor.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mingo@redhat.com \
--cc=rdunlap@infradead.org \
--cc=tglx@linutronix.de \
--cc=x86@kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).