Skip to content

Commit 40d35bf

Browse files
vegardJonathan Corbet
authored andcommitted
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: Vegard Nossum <vegard.nossum@oracle.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <20231022184910.919201-1-vegard.nossum@oracle.com>
1 parent a10874e commit 40d35bf

1 file changed

Lines changed: 4 additions & 0 deletions

File tree

Documentation/doc-guide/contributing.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -138,6 +138,10 @@ times, but it's highly important. If we can actually eliminate warnings
138138
from the documentation build, then we can start expecting developers to
139139
avoid adding new ones.
140140

141+
In addition to warnings from the regular documentation build, you can also
142+
run ``make refcheckdocs`` to find references to nonexistent documentation
143+
files.
144+
141145
Languishing kerneldoc comments
142146
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
143147

0 commit comments

Comments
 (0)