lkml.org 
[lkml]   [2019]   [Dec]   [9]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
From
SubjectRe: [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).

\
 
 \ /
  Last update: 2019-12-09 17:59    [W:0.032 / U:24.004 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site