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

From: Jonathan Corbet
Date: Wed Sep 09 2020 - 13:37:03 EST


On Sun, 30 Aug 2020 17:43:54 -0700
Randy Dunlap <rdunlap@xxxxxxxxxxxxx> wrote:

> From: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
>
> 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@xxxxxxxxxxxxx>
> Cc: Mike Rapoport <rppt@xxxxxxxxxx>
> ---
> v2: insert "new" inside "without warnings/errors" (Mike)
>
> 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 new warnings/errors.
> + Use ``make htmldocs`` or ``make pdfdocs`` to check the build and
> + fix any issues.
> +

Applied, thanks.

jon