linux-kernel - Re: [PATCH] Documentation: submit-checklist: add Documentation clean builds

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] [day] [month] [year] [list]

Message-ID: <203a91be-4ee4-5466-acd7-531e24792422@infradead.org>
Date:   Sun, 30 Aug 2020 07:54:16 -0700
From:   Randy Dunlap <rdunlap@...radead.org>
To:     Mike Rapoport <rppt@...nel.org>
Cc:     LKML <linux-kernel@...r.kernel.org>,
        "linux-doc@...r.kernel.org" <linux-doc@...r.kernel.org>,
        "linux-next@...r.kernel.org" <linux-next@...r.kernel.org>,
        Jonathan Corbet <corbet@....net>
Subject: Re: [PATCH] Documentation: submit-checklist: add Documentation clean
 builds

On 8/30/20 4:41 AM, Mike Rapoport wrote:
> On Sun, Aug 23, 2020 at 05:38:12PM -0700, Randy Dunlap wrote:
>> From: Randy Dunlap <rdunlap@...radead.org>
>>
>> Add to Documentation/process/submit-checklist.rst that patch
>> submitters should run "make htmldocs" and verify that any
>> Documentation/ changes (patches) are clean (no new warnings/errors).
>>
>> Signed-off-by: Randy Dunlap <rdunlap@...radead.org>
>> ---
>>  Documentation/process/submit-checklist.rst |    4 ++++
>>  1 file changed, 4 insertions(+)
>>
>> --- linux-next-20200821.orig/Documentation/process/submit-checklist.rst
>> +++ linux-next-20200821/Documentation/process/submit-checklist.rst
>> @@ -24,6 +24,10 @@ and elsewhere regarding submitting Linux
>>  
>>    c) Builds successfully when using ``O=builddir``
>>  
>> +  d) Any Documentation/ changes build successfully without warnings/errors.
> 
> Maybe "... without new warnings/errors"?
> Unfortunately we still have plenty of old ones...

Yes, I'll change that.
Thanks.

>> +     Use ``make htmldocs`` or ``make pdfdocs`` to check the build and
>> +     fix any issues.
>> +
>>  3) Builds on multiple CPU architectures by using local cross-compile tools
>>     or some other build farm.
>>  
>>

-- 
~Randy