Intel doc built failure in DPDK CI testing

Intel doc built failure in DPDK CI testing

[Patrick Robb]

[-- Attachment #1: Type: text/plain, Size: 2526 bytes --]

Hello,

I recently submitted a patchseries to DPDK, which Intel DPDK Lab is
reporting a build failure for:

failure email:
https://mails.dpdk.org/archives/test-report/2025-November/927503.html
series: https://patchwork.dpdk.org/project/dpdk/list/?series=36596

failure:

---------------

*Build Failed #1:
OS: UB2404-64
Target: x86_64-native-linuxapp-doc
FAILED: doc/guides/html
/usr/bin/python3 ../buildtools/call-sphinx-build.py /usr/bin/sphinx-build
25.11.0-rc1
/root/UB2404-64_K6.8.0_GCC13.3.0/x86_64-native-linuxapp-doc/36596/dpdk/doc/guides
/root/UB2404-64_K6.8.0_GCC13.3.0/x86_64-native-linuxapp-doc/36596/dpdk/x86_64-native-linuxapp-doc/doc/guides
-a -W

Warning, treated as error:
/root/UB2404-64_K6.8.0_GCC13.3.0/x86_64-native-linuxapp-doc/36596/dpdk/doc/guides/tools/dts.rst:555:Include
file
'/root/UB2404-64_K6.8.0_GCC13.3.0/x86_64-native-linuxapp-doc/36596/dpdk/dts/test_run.example.yaml'
not found or reading it failed
[3674/3674] Generating doc/api/dts/dts_api_html with a custom command
ninja: build stopped

--------------------

The above says the failure is caused because dpdk/dts/test_run.example.yaml
is not found, and it is referenced in line 555 of dts.rst. That makes
sense, given that dts/test_run.example.yaml is removed in my series, and
moved into a new directory (dts/configuration). So, now the path for this
file is dts/configuration/test_run.example.yaml. However, this should not
be an issue for the build, because dts.rest is updated in my patchseries to
reflect the new configuration paths. See:
https://patchwork.dpdk.org/project/dpdk/patch/20251105223628.1659390-3-probb@iol.unh.edu/

diff:

@@ -549,20 +576,20 @@  And they both have two network ports which are
physically connected to each othe

 .. _test_run_configuration_example:

-``dts/test_run.example.yaml``
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+``dts/configurations/test_run.example.yaml``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

-.. literalinclude:: ../../../dts/test_run.example.yaml
+.. literalinclude:: ../../../dts/configurations/test_run.example.yaml
    :language: yaml
    :start-at: # Define


The diff above which is a part of my series should be ensuring that the
reference to dts/test_run.example.yaml is removed, but it is clearly still
remaining in the DPDK artifact you are using for your build for testing.
Can you check this, and check whether my patch is being properly applied
before the doc build starts? Please let me know if I am making any errors,
I am happy to re-submit differently as needed!

Thanks.

[-- Attachment #2: Type: text/html, Size: 3122 bytes --]

Re: Intel doc built failure in DPDK CI testing

[Aaron Conole]

Patrick Robb <probb@iol.unh.edu> writes:

> Hello,
>
> I recently submitted a patchseries to DPDK, which Intel DPDK Lab is reporting a build failure
> for:
>
> failure email: https://mails.dpdk.org/archives/test-report/2025-November/927503.html
> series: https://patchwork.dpdk.org/project/dpdk/list/?series=36596

NOTE that you'll need to respin the series anyway due to SPDX failure.

BUT, I agree something might be amiss in the intel setup - the doc build
in github actions passed:
https://github.com/ovsrobot/dpdk/actions/runs/19119065633/job/54635284364

> failure: 
>
> ---------------
>
> *Build Failed #1:
> OS: UB2404-64
> Target: x86_64-native-linuxapp-doc
> FAILED: doc/guides/html 
> /usr/bin/python3 ../buildtools/call-sphinx-build.py /usr/bin/sphinx-build 25.11.0-rc1
> /root/UB2404-64_K6.8.0_GCC13.3.0/x86_64-native-linuxapp-doc/36596/dpdk/doc/guides
> /root/UB2404-64_K6.8.0_GCC13.3.0/x86_64-native-linuxapp-doc/36596/dpdk/x86_64-native-linuxapp-doc/doc/guides
> -a -W
>
> Warning, treated as error:
> /root/UB2404-64_K6.8.0_GCC13.3.0/x86_64-native-linuxapp-doc/36596/dpdk/doc/guides/tools/dts.rst:555:Include
> file
> '/root/UB2404-64_K6.8.0_GCC13.3.0/x86_64-native-linuxapp-doc/36596/dpdk/dts/test_run.example.yaml'
> not found or reading it failed
> [3674/3674] Generating doc/api/dts/dts_api_html with a custom command
> ninja: build stopped
>
> --------------------
>
> The above says the failure is caused because dpdk/dts/test_run.example.yaml is not found,
> and it is referenced in line 555 of dts.rst. That makes sense, given that
> dts/test_run.example.yaml is removed in my series, and moved into a new directory
> (dts/configuration). So, now the path for this file is
> dts/configuration/test_run.example.yaml. However, this should not be an issue for the
> build, because dts.rest is updated in my patchseries to reflect the new configuration paths.
> See:
> https://patchwork.dpdk.org/project/dpdk/patch/20251105223628.1659390-3-probb@iol.unh.edu/
>
>
> diff: 
>
> @@ -549,20 +576,20 @@  And they both have two network ports which are physically
> connected to each othe
>  
>  .. _test_run_configuration_example:
>  
> -``dts/test_run.example.yaml``
> -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> +``dts/configurations/test_run.example.yaml``
> +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>  
> -.. literalinclude:: ../../../dts/test_run.example.yaml
> +.. literalinclude:: ../../../dts/configurations/test_run.example.yaml
>     :language: yaml
>     :start-at: # Define
>  
>
> The diff above which is a part of my series should be ensuring that the reference to
> dts/test_run.example.yaml is removed, but it is clearly still remaining in the DPDK artifact
> you are using for your build for testing. Can you check this, and check whether my patch is
> being properly applied before the doc build starts? Please let me know if I am making any
> errors, I am happy to re-submit differently as needed! 
>
> Thanks.