lists.openwall.net   lists  /  announce  owl-users  owl-dev  john-users  john-dev  passwdqc-users  yescrypt  popa3d-users  /  oss-security  kernel-hardening  musl  sabotage  tlsify  passwords  /  crypt-dev  xvendor  /  Bugtraq  Full-Disclosure  linux-kernel  linux-netdev  linux-ext4  linux-hardening  linux-cve-announce  PHC 
Open Source and information security mailing list archives
 
Hash Suite: Windows password security audit tool. GUI, reports in PDF.
[<prev] [next>] [<thread-prev] [day] [month] [year] [list]
Message-ID: <87il6yjc52.fsf@meer.lwn.net>
Date:   Sun, 22 Oct 2023 20:39:05 -0600
From:   Jonathan Corbet <corbet@....net>
To:     Vegard Nossum <vegard.nossum@...cle.com>,
        Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
Cc:     linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org,
        Vegard Nossum <vegard.nossum@...cle.com>
Subject: Re: [PATCH] docs: doc-guide: mention 'make refcheckdocs'

Vegard Nossum <vegard.nossum@...cle.com> writes:

> Add this to the section on fixing warnings.
>
> Cc: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
> Cc: Jonathan Corbet <corbet@....net>
> Signed-off-by: Vegard Nossum <vegard.nossum@...cle.com>
> ---
>  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

Powered by blists - more mailing lists

Powered by Openwall GNU/*/Linux Powered by OpenVZ