Commit 9334e34f authored Aug 30, 2020 by Randy Dunlap Committed by Jonathan Corbet Sep 09, 2020

Documentation: submit-checklist: add clean builds for new Documentation



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>
Reviewed-by: Mike Rapoport <rppt@linux.ibm.com>
Link: https://lore.kernel.org/r/cf5bbdf5-03ff-0606-a6d4-ca196d90aee9@infradead.org


Signed-off-by: Jonathan Corbet <corbet@lwn.net>

parent e046de3d

Documentation/process/submit-checklist.rst

+4 −0

Original line number	Diff line number	Diff line
		@@ -24,6 +24,10 @@ and elsewhere regarding submitting Linux kernel patches.

		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.

		3) Builds on multiple CPU architectures by using local cross-compile tools
		or some other build farm.

Admin message