linux-kernel - Re: [PATCH] docs: Makefile: Add dependency to $(YNL

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: <878r2wo8md.fsf@meer.lwn.net>
Date: Tue, 05 Mar 2024 11:07:22 -0700
From: Jonathan Corbet <corbet@....net>
To: Akira Yokosawa <akiyks@...il.com>, linux-doc@...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>, netdev@...r.kernel.org,
 linux-kernel@...r.kernel.org, Vegard Nossum <vegard.nossum@...cle.com>,
 Jani Nikula <jani.nikula@...ux.intel.com>, Akira Yokosawa
 <akiyks@...il.com>
Subject: Re: [PATCH] docs: Makefile: Add dependency to $(YNL_INDEX) for
 targets other than htmldocs

Akira Yokosawa <akiyks@...il.com> 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@...il.com>
> Cc: stable@...r.kernel.org  # v6.7
> 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>
> ---
> 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