diff options
| author | Randy Dunlap <rdunlap@infradead.org> | 2020-08-31 02:43:54 +0200 |
|---|---|---|
| committer | Jonathan Corbet <corbet@lwn.net> | 2020-09-09 19:36:39 +0200 |
| commit | 9334e34fe1d5dec2bcfd41a4a1317d284ab1d61f (patch) | |
| tree | dec53aa798d110158975e9843234c6c4d490856e /Documentation/process | |
| parent | docs: filesystems: replace to_dev() with kobj_to_dev() (diff) | |
| download | linux-9334e34fe1d5dec2bcfd41a4a1317d284ab1d61f.tar.xz linux-9334e34fe1d5dec2bcfd41a4a1317d284ab1d61f.zip | |
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>
Diffstat (limited to 'Documentation/process')
| -rw-r--r-- | Documentation/process/submit-checklist.rst | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/Documentation/process/submit-checklist.rst b/Documentation/process/submit-checklist.rst index 3f8e9d5d95c2..b681e862a335 100644 --- a/Documentation/process/submit-checklist.rst +++ b/Documentation/process/submit-checklist.rst @@ -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. |