LinuxLists.cc - [PATCH] docs: Makefile: Fix make cleandocs by deleting generated .rst files

2024-02-08 18:53:59

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

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 <[email protected]>
---
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

--
2.39.2

2024-02-08 22:52:25

by Jonathan Corbet

[permalink] [raw]

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

Thorsten Blum <[email protected]> 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 <[email protected]>
> ---
> 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

2024-02-09 09:39:16

by Breno Leitao

[permalink] [raw]

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

On Thu, Feb 08, 2024 at 03:52:08PM -0700, Jonathan Corbet wrote:
> Thorsten Blum <[email protected]> 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 <[email protected]>
> > ---
> > 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)

I haven't check but I _think_ that just deleting $(YNL_INDEX) is enough
here, since $(YNL_INDEX) depends on $(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...

Agree. This is definitely worth doing.

2024-02-09 10:11:15

by Vegard Nossum

[permalink] [raw]

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

On 09/02/2024 10:38, Breno Leitao wrote:
> On Thu, Feb 08, 2024 at 03:52:08PM -0700, Jonathan Corbet wrote:
>> Thorsten Blum <[email protected]> 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 <[email protected]>
>>> ---
>>> 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)
>
> 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 <[email protected]>

Vegard

2024-02-14 22:44:01

by Jonathan Corbet

[permalink] [raw]