linux-kernel - Re: [RFC] Proposal to relax warnings of htmldocs

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: <87fs4jrpth.fsf@meer.lwn.net>
Date:   Wed, 16 Aug 2023 09:04:42 -0600
From:   Jonathan Corbet <corbet@....net>
To:     Carlos Bilbao <carlos.bilbao@....com>,
        "linux-doc@...r.kernel.org" <linux-doc@...r.kernel.org>,
        Linux Kernel Mailing List <linux-kernel@...r.kernel.org>
Cc:     Avadhut Naik <Avadhut.Naik@....com>,
        Miguel Ojeda <ojeda@...nel.org>,
        Akira Yokosawa <akiyks@...il.com>,
        Matthew Wilcox <willy@...radead.org>
Subject: Re: [RFC] Proposal to relax warnings of htmldocs

Carlos Bilbao <carlos.bilbao@....com> writes:

>> ...other than fixing the actual problems? :)
>
> I'm happy to fix as many as I can, but there are obstacles e.g. some things
> lack documentation, such as undocumented fields in structures with names
> that nobody but their creator could decipher. Also, that won't solve the
> underlying warning display problem (which maybe it's W!=1, as noted by
> Matthew.

I *did* put a smiley on that...

>>> I suggest for the command `make htmldocs` to
>>> only display, by default, warnings directly related to the changes being
>>> made, unless explicitly requested otherwisee.
>>>
>>> I'm thinking we could do this, for example, by making hmtldocs a two-step
>>> process: First running htmldocs as usual but with warnings disabled, and
>>> then generating docs again but only for the new files (see $git diff
>>> --name-only HEAD), with warnings active but limited to the scope of the
>>> changes made.
>> 
>> A normal build should just generate warnings for files that have
>> changed (since the last build).  Does that not do what you want?
>
> That's not the behavior I see on my system, when I run `make htmldocs` I
> see many warnings from other places.It floods my screen. The default
> behavior appears to change between configurations and compilers.

Warnings that are generated at output time, such as broken references,
will come out every time.  Those generated during the read phase are
generally limited to what has been changed.  I rely on that pretty
heavily to do incremental builds when applying patches.  If you're doing
a full rebuild after changing one file, something strange is happening.

Thanks,

jon