Received-SPF: pass (google.com: domain of linux-kernel+bounces-58797-linux.lists.archive=gmail.com@vger.kernel.org designates 139.178.88.99 as permitted sender) client-ip=139.178.88.99;
From: Jonathan Corbet <corbet@lwn.net>
To: Thorsten Blum <thorsten.blum@toblux.com>
Cc: linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, Thorsten Blum
 <thorsten.blum@toblux.com>, Vegard Nossum <vegard.nossum@oracle.com>,
 Breno Leitao <leitao@debian.org>
Subject: Re: [PATCH] docs: Makefile: Fix make cleandocs by deleting
 generated .rst files
In-Reply-To: <20240208145001.61769-1-thorsten.blum@toblux.com>
References: <20240208145001.61769-1-thorsten.blum@toblux.com>
Date: Thu, 08 Feb 2024 15:52:08 -0700
Message-ID: <87a5oafu1z.fsf@meer.lwn.net>
Precedence: bulk
MIME-Version: 1.0
Content-Type: text/plain

Thorsten Blum <thorsten.blum@toblux.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@toblux.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