* [PATCH] docs: Makefile: Fix make cleandocs by deleting generated .rst files
@ 2024-02-08 14:50 Thorsten Blum
2024-02-08 22:52 ` Jonathan Corbet
2024-02-14 22:43 ` Jonathan Corbet
0 siblings, 2 replies; 5+ messages in thread
From: Thorsten Blum @ 2024-02-08 14:50 UTC (permalink / raw)
To: Jonathan Corbet; +Cc: linux-doc, linux-kernel, Thorsten Blum
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
--
2.39.2
^ permalink raw reply related [flat|nested] 5+ messages in thread
* Re: [PATCH] docs: Makefile: Fix make cleandocs by deleting generated .rst files
2024-02-08 14:50 [PATCH] docs: Makefile: Fix make cleandocs by deleting generated .rst files Thorsten Blum
@ 2024-02-08 22:52 ` Jonathan Corbet
2024-02-09 9:38 ` Breno Leitao
2024-02-14 22:43 ` Jonathan Corbet
1 sibling, 1 reply; 5+ messages in thread
From: Jonathan Corbet @ 2024-02-08 22:52 UTC (permalink / raw)
To: Thorsten Blum
Cc: linux-doc, linux-kernel, Thorsten Blum, Vegard Nossum,
Breno Leitao
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
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [PATCH] docs: Makefile: Fix make cleandocs by deleting generated .rst files
2024-02-08 22:52 ` Jonathan Corbet
@ 2024-02-09 9:38 ` Breno Leitao
2024-02-09 10:10 ` Vegard Nossum
0 siblings, 1 reply; 5+ messages in thread
From: Breno Leitao @ 2024-02-09 9:38 UTC (permalink / raw)
To: Jonathan Corbet; +Cc: Thorsten Blum, linux-doc, linux-kernel, Vegard Nossum
On Thu, Feb 08, 2024 at 03:52:08PM -0700, Jonathan Corbet wrote:
> 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)
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.
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [PATCH] docs: Makefile: Fix make cleandocs by deleting generated .rst files
2024-02-09 9:38 ` Breno Leitao
@ 2024-02-09 10:10 ` Vegard Nossum
0 siblings, 0 replies; 5+ messages in thread
From: Vegard Nossum @ 2024-02-09 10:10 UTC (permalink / raw)
To: Breno Leitao, Jonathan Corbet; +Cc: Thorsten Blum, linux-doc, linux-kernel
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@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)
>
> 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@oracle.com>
Vegard
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [PATCH] docs: Makefile: Fix make cleandocs by deleting generated .rst files
2024-02-08 14:50 [PATCH] docs: Makefile: Fix make cleandocs by deleting generated .rst files Thorsten Blum
2024-02-08 22:52 ` Jonathan Corbet
@ 2024-02-14 22:43 ` Jonathan Corbet
1 sibling, 0 replies; 5+ messages in thread
From: Jonathan Corbet @ 2024-02-14 22:43 UTC (permalink / raw)
To: Thorsten Blum; +Cc: linux-doc, linux-kernel, Thorsten Blum
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
Applied, thanks.
jon
^ permalink raw reply [flat|nested] 5+ messages in thread
end of thread, other threads:[~2024-02-14 22:43 UTC | newest]
Thread overview: 5+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2024-02-08 14:50 [PATCH] docs: Makefile: Fix make cleandocs by deleting generated .rst files Thorsten Blum
2024-02-08 22:52 ` Jonathan Corbet
2024-02-09 9:38 ` Breno Leitao
2024-02-09 10:10 ` Vegard Nossum
2024-02-14 22:43 ` Jonathan Corbet
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).