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

From: Vegard Nossum
Date: Fri Feb 09 2024 - 05:11:17 EST

On 09/02/2024 10:38, Breno Leitao wrote:
On Thu, Feb 08, 2024 at 03:52:08PM -0700, Jonathan Corbet wrote:
Thorsten Blum <thorsten.blum@xxxxxxxxxx> writes:

The script tools/net/ynl/ (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@xxxxxxxxxx>
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
+ $(Q)rm -f $(YNL_INDEX) $(YNL_RST_FILES)

I haven't check but I _think_ that just deleting $(YNL_INDEX) is enough
here, since $(YNL_INDEX) depends on $(YNL_RST_FILES).

I think removing all of them is the right thing to do.

$(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...

Agree. This is definitely worth doing.

Agree too.

I'll have a look into putting those files in the build directory, this
patch shouldn't affect that.

Reviewed-by: Vegard Nossum <vegard.nossum@xxxxxxxxxx>