[PATCH] Documentation: submit-checklist: add Documentation clean builds

[PATCH] Documentation: submit-checklist: add Documentation clean builds

[Randy Dunlap]

From: Randy Dunlap <rdunlap@infradead.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@infradead.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.
+     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.
 

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

[Mike Rapoport]

On Sun, Aug 23, 2020 at 05:38:12PM -0700, Randy Dunlap wrote:
> From: Randy Dunlap <rdunlap@infradead.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@infradead.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...

> +     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.
>  
> 

-- 
Sincerely yours,
Mike.

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

[Randy Dunlap]

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@infradead.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@infradead.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