Commit 40d35bf9 authored by Vegard Nossum's avatar Vegard Nossum Committed by Jonathan Corbet
Browse files

docs: doc-guide: mention 'make refcheckdocs' 



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: default avatarVegard Nossum <vegard.nossum@oracle.com>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
Message-ID: <20231022184910.919201-1-vegard.nossum@oracle.com>
parent a10874e8

Documentation/doc-guide/contributing.rst

+4 −0
Original line number Diff line number Diff line
@@ -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

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~