diff options
| author |   Vegard Nossum <vegard.nossum@oracle.com> | 2023-10-22 20:49:10 +0200 |
|---|---|---|
| committer |   Jonathan Corbet <corbet@lwn.net> | 2023-10-22 20:38:55 -0600 |
| commit | 40d35bf9633d76185877f162e167eb09d7ccea0a (patch) | |
| tree | bc7c99506a67d17ec795de0b6ed1b3ad27c3af5e /Documentation/doc-guide | |
| parent | Documentation: fix typo in dynamic-debug howto (diff) | |
| download | wireguard-linux-40d35bf9633d76185877f162e167eb09d7ccea0a.tar.xz wireguard-linux-40d35bf9633d76185877f162e167eb09d7ccea0a.zip | |
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>
Diffstat (limited to 'Documentation/doc-guide')
| -rw-r--r-- | Documentation/doc-guide/contributing.rst | 4 |
1 files changed, 4 insertions, 0 deletions
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 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |