linux-kernel - Re: FAILED: Patch "docs: Makefile: Add dependency to $(YNL_INDEX) for targets other than htmldocs" failed to apply to 6.7-stable tree

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <8ce05c2d-eb0d-4c30-8e1e-eaf22528779e@gmail.com>
Date: Wed, 27 Mar 2024 23:45:07 +0900
From: Akira Yokosawa <akiyks@...il.com>
To: Sasha Levin <sashal@...nel.org>, stable@...r.kernel.org
Cc: Thorsten Blum <thorsten.blum@...lux.com>, Breno Leitao
 <leitao@...ian.org>, Jakub Kicinski <kuba@...nel.org>,
 "David S. Miller" <davem@...emloft.net>, Jonathan Corbet <corbet@....net>,
 linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: Re: FAILED: Patch "docs: Makefile: Add dependency to $(YNL_INDEX) for
 targets other than htmldocs" failed to apply to 6.7-stable tree

On Wed, 27 Mar 2024 08:08:42 -0400, Sasha Levin wrote:
> The patch below does not apply to the 6.7-stable tree.
> If someone wants it applied there, or to any other stable or longterm
> tree, then please email the backport, including the original git commit
> id to <stable@...r.kernel.org>.
> 
> Thanks,
> Sasha
> 
> ------------------ original commit in Linus's tree ------------------
> 
> From a304fa1d10fcb974c117d391e5b4d34c2baa9a62 Mon Sep 17 00:00:00 2001
> From: Akira Yokosawa <akiyks@...il.com>
> Date: Tue, 5 Mar 2024 13:23:00 +0900
> Subject: [PATCH] docs: Makefile: Add dependency to $(YNL_INDEX) for targets
>  other than htmldocs
> 
> 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@...il.com>
> Cc: stable@...r.kernel.org  # v6.7

My bad.

This should have been "# v6.8".
No need of backport.  Sorry for making the noise.

        Regards, Akira

> Cc: Thorsten Blum <thorsten.blum@...lux.com>
> Cc: Breno Leitao <leitao@...ian.org>
> Cc: Jakub Kicinski <kuba@...nel.org>
> Cc: "David S. Miller" <davem@...emloft.net>
> Reviwed-by: Breno Leitao <leitao@...ian.org>
> Signed-off-by: Jonathan Corbet <corbet@....net>
> Message-ID: <e876e3c8-109d-4bc8-9916-05a4bc4ee9ac@...il.com>
> ---
>  Documentation/Makefile | 4 +++-
>  1 file changed, 3 insertions(+), 1 deletion(-)
> 
> diff --git a/Documentation/Makefile b/Documentation/Makefile
> index 4479910166fc1..b68f8c816897b 100644
> --- a/Documentation/Makefile
> +++ b/Documentation/Makefile
> @@ -111,7 +111,9 @@ $(YNL_INDEX): $(YNL_RST_FILES)
>  $(YNL_RST_DIR)/%.rst: $(YNL_YAML_DIR)/%.yaml $(YNL_TOOL)
>  	$(Q)$(YNL_TOOL) -i $< -o $@
>  
> -htmldocs: $(YNL_INDEX)
> +htmldocs texinfodocs latexdocs epubdocs xmldocs: $(YNL_INDEX)
> +
> +htmldocs:
>  	@$(srctree)/scripts/sphinx-pre-install --version-check
>  	@+$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,html,$(var),,$(var)))
>