Re: [PATCH] docs: Makefile: Add dependency to $(YNL_INDEX) for targets other than htmldocs
From: Jonathan Corbet
Date: Tue Mar 05 2024 - 13:07:37 EST
Akira Yokosawa <akiyks@xxxxxxxxx> writes:
> Commit f061c9f7d058 ("Documentation: Document each netlink family")
> added recipes for YAML -> RST conversion.
> Then commit 7da8bdbf8f5d ("docs: Makefile: Fix make cleandocs by
> deleting generated .rst files") made sure those converted .rst files
> are cleaned by "make cleandocs".
>
> However, they took care of htmldocs build only.
>
> If one of other targets such as latexdocs or epubdocs is built
> without building htmldocs, missing .rst files can cause additional
> WARNINGs from sphinx-build as follow:
>
> ./Documentation/userspace-api/netlink/specs.rst:18: WARNING: undefined label: 'specs'
> ./Documentation/userspace-api/netlink/netlink-raw.rst:64: WARNING: unknown document: '../../networking/netlink_spec/rt_link'
> ./Documentation/userspace-api/netlink/netlink-raw.rst:64: WARNING: unknown document: '../../networking/netlink_spec/tc'
> ./Documentation/userspace-api/netlink/index.rst:21: WARNING: undefined label: 'specs'
>
> Add dependency to $(YNL_INDEX) for other targets and allow any targets
> to be built cleanly right after "make cleandocs".
>
> Signed-off-by: Akira Yokosawa <akiyks@xxxxxxxxx>
> Cc: stable@xxxxxxxxxxxxxxx # v6.7
> Cc: Thorsten Blum <thorsten.blum@xxxxxxxxxx>
> Cc: Breno Leitao <leitao@xxxxxxxxxx>
> Cc: Jakub Kicinski <kuba@xxxxxxxxxx>
> Cc: David S. Miller <davem@xxxxxxxxxxxxx>
> ---
> Hi,
>
> While the first offending commit went through the -net tree,
> I'd like Jon to pick this up provided there is no objection from
> Jakub or davem.
Applied, thanks.
jon