Thread (3 messages) 3 messages, 2 authors, 2020-08-30

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

From: Mike Rapoport <rppt@kernel.org>
Date: 2020-08-30 11:42:02
Also in: linux-next, lkml

On Sun, Aug 23, 2020 at 05:38:12PM -0700, Randy Dunlap wrote:
quoted hunk ↗ jump to hunk
From: Randy Dunlap <redacted>

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 <redacted>
---
 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.
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help