Add this to the section on fixing warnings.
Cc: Mauro Carvalho Chehab <[email protected]>
Cc: Jonathan Corbet <[email protected]>
Signed-off-by: Vegard Nossum <[email protected]>
---
Documentation/doc-guide/contributing.rst | 4 ++++
1 file changed, 4 insertions(+)
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
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
--
2.34.1
Vegard Nossum <[email protected]> writes:
> Add this to the section on fixing warnings.
>
> Cc: Mauro Carvalho Chehab <[email protected]>
> Cc: Jonathan Corbet <[email protected]>
> Signed-off-by: Vegard Nossum <[email protected]>
> ---
> Documentation/doc-guide/contributing.rst | 4 ++++
> 1 file changed, 4 insertions(+)
>
> 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.
Applied, thanks.
jon