[PATCH] doc: raise an error on warnings for dts

[PATCH] doc: raise an error on warnings for dts

[David Marchand]

Similarly to commit 6572fc926037 ("doc: make sphinx comply with ..."),
pass -W to sphinx to catch warnings.

Signed-off-by: David Marchand <david.marchand@redhat.com>
---
 doc/api/dts/meson.build | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/doc/api/dts/meson.build b/doc/api/dts/meson.build
index 8a6d061879..fc147f13f3 100644
--- a/doc/api/dts/meson.build
+++ b/doc/api/dts/meson.build
@@ -12,6 +12,9 @@ if python_ver_satisfied != 0
 endif
 
 extra_sphinx_args = ['-E', '-c', join_paths(doc_source_dir, 'guides')]
+if get_option('werror')
+    extra_sphinx_args += '-W'
+endif
 
 # DTS docs are generated inside main Doxygen docs build directory
 # DTS docs relies on main docs to install it so does not define install dir
-- 
2.52.0

Re: [PATCH] doc: raise an error on warnings for dts

[Thomas Monjalon]

21/01/2026 11:01, David Marchand:
> Similarly to commit 6572fc926037 ("doc: make sphinx comply with ..."),
> pass -W to sphinx to catch warnings.
> 
> Signed-off-by: David Marchand <david.marchand@redhat.com>

Acked-by: Thomas Monjalon <thomas@monjalon.net>

Note: "dts" could be uppercased in the title

RE: [PATCH] doc: raise an error on warnings for dts

[Marat Khalili]

> -----Original Message-----
> From: David Marchand <david.marchand@redhat.com>
> Sent: Wednesday 21 January 2026 10:01
> To: dev@dpdk.org
> Cc: probb@iol.unh.edu; bruce.richardson@intel.com; thomas@monjalon.net
> Subject: [PATCH] doc: raise an error on warnings for dts
> 
> Similarly to commit 6572fc926037 ("doc: make sphinx comply with ..."),
> pass -W to sphinx to catch warnings.
> 
> Signed-off-by: David Marchand <david.marchand@redhat.com>
> ---
>  doc/api/dts/meson.build | 3 +++
>  1 file changed, 3 insertions(+)
> 
> diff --git a/doc/api/dts/meson.build b/doc/api/dts/meson.build
> index 8a6d061879..fc147f13f3 100644
> --- a/doc/api/dts/meson.build
> +++ b/doc/api/dts/meson.build
> @@ -12,6 +12,9 @@ if python_ver_satisfied != 0
>  endif
> 
>  extra_sphinx_args = ['-E', '-c', join_paths(doc_source_dir, 'guides')]
> +if get_option('werror')
> +    extra_sphinx_args += '-W'
> +endif
> 
>  # DTS docs are generated inside main Doxygen docs build directory
>  # DTS docs relies on main docs to install it so does not define install dir
> --
> 2.52.0

Acked-by: Marat Khalili <marat.khalili@huawei.com>
Tested-by: Marat Khalili <marat.khalili@huawei.com>

Re: [PATCH] doc: raise an error on warnings for dts

[David Marchand]

On Wed, 21 Jan 2026 at 11:01, David Marchand <david.marchand@redhat.com> wrote:
>
> Similarly to commit 6572fc926037 ("doc: make sphinx comply with ..."),
> pass -W to sphinx to catch warnings.
>
> Signed-off-by: David Marchand <david.marchand@redhat.com>
> ---
>  doc/api/dts/meson.build | 3 +++
>  1 file changed, 3 insertions(+)
>
> diff --git a/doc/api/dts/meson.build b/doc/api/dts/meson.build
> index 8a6d061879..fc147f13f3 100644
> --- a/doc/api/dts/meson.build
> +++ b/doc/api/dts/meson.build
> @@ -12,6 +12,9 @@ if python_ver_satisfied != 0
>  endif
>
>  extra_sphinx_args = ['-E', '-c', join_paths(doc_source_dir, 'guides')]
> +if get_option('werror')
> +    extra_sphinx_args += '-W'
> +endif
>
>  # DTS docs are generated inside main Doxygen docs build directory
>  # DTS docs relies on main docs to install it so does not define install dir

Applied, thanks.


-- 
David Marchand