linux-kernel - Re: [PATCH] docs: Makefile: Fix make cleandocs by deleting generated .rst files

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] [thread-next>] [day] [month] [year] [list]

Message-ID: <87a5oafu1z.fsf@meer.lwn.net>
Date: Thu, 08 Feb 2024 15:52:08 -0700
From: Jonathan Corbet <corbet@....net>
To: Thorsten Blum <thorsten.blum@...lux.com>
Cc: linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org, Thorsten Blum
 <thorsten.blum@...lux.com>, Vegard Nossum <vegard.nossum@...cle.com>,
 Breno Leitao <leitao@...ian.org>
Subject: Re: [PATCH] docs: Makefile: Fix make cleandocs by deleting
 generated .rst files

Thorsten Blum <thorsten.blum@...lux.com> writes:

> The script tools/net/ynl/ynl-gen-rst.py (YNL_TOOL) generates several .rst
> files (YNL_INDEX, YNL_RST_FILES) in Documentation/networking/netlink_spec
> (YNL_RST_DIR) which are not deleted by make cleandocs.
>
> Fix make cleandocs by deleting the generated .rst files.
>
> Signed-off-by: Thorsten Blum <thorsten.blum@...lux.com>
> ---
>  Documentation/Makefile | 1 +
>  1 file changed, 1 insertion(+)
>
> diff --git a/Documentation/Makefile b/Documentation/Makefile
> index 3885bbe260eb..4479910166fc 100644
> --- a/Documentation/Makefile
> +++ b/Documentation/Makefile
> @@ -176,6 +176,7 @@ refcheckdocs:
>  	$(Q)cd $(srctree);scripts/documentation-file-ref-check
>  
>  cleandocs:
> +	$(Q)rm -f $(YNL_INDEX) $(YNL_RST_FILES)
>  	$(Q)rm -rf $(BUILDDIR)
>  	$(Q)$(MAKE) BUILDDIR=$(abspath $(BUILDDIR)) $(build)=Documentation/userspace-api/media clean

So this seems worth doing ... except that there has been talk about not
depositing those files into the source tree in the first place.  Adding
Vegard and Breno to see if they have any thoughts on the matter...

Thanks,

jon