docs: doc-guide: mention 'make refcheckdocs'
authorVegard Nossum <vegard.nossum@oracle.com>
Sun, 22 Oct 2023 18:49:10 +0000 (20:49 +0200)
committerJonathan Corbet <corbet@lwn.net>
Mon, 23 Oct 2023 02:38:55 +0000 (20:38 -0600)
Add this to the section on fixing warnings.

Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Cc: Jonathan Corbet <corbet@lwn.net>
Signed-off-by: Vegard Nossum <vegard.nossum@oracle.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <20231022184910.919201-1-vegard.nossum@oracle.com>

Documentation/doc-guide/contributing.rst

index d479382..662c7a8 100644 (file)
@@ -138,6 +138,10 @@ times, but it's highly important.  If we can actually eliminate warnings
 from the documentation build, then we can start expecting developers to
 avoid adding new ones.
 
+In addition to warnings from the regular documentation build, you can also
+run ``make refcheckdocs`` to find references to nonexistent documentation
+files.
+
 Languishing kerneldoc comments
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~