From 40d35bf9633d76185877f162e167eb09d7ccea0a Mon Sep 17 00:00:00 2001 From: Vegard Nossum Date: Sun, 22 Oct 2023 20:49:10 +0200 Subject: docs: doc-guide: mention 'make refcheckdocs' Add this to the section on fixing warnings. Cc: Mauro Carvalho Chehab Cc: Jonathan Corbet Signed-off-by: Vegard Nossum Signed-off-by: Jonathan Corbet Message-ID: <20231022184910.919201-1-vegard.nossum@oracle.com> --- Documentation/doc-guide/contributing.rst | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'Documentation/doc-guide') diff --git a/Documentation/doc-guide/contributing.rst b/Documentation/doc-guide/contributing.rst index d4793826ad9a..662c7a840cd5 100644 --- a/Documentation/doc-guide/contributing.rst +++ b/Documentation/doc-guide/contributing.rst @@ -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 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -- cgit v1.2.3-59-g8ed1b