Re: [PATCH] dts: fix doxygen API link

[David Marchand <david.marchand@redhat.com>]

On Wed, Oct 23, 2024 at 4:58 PM Paul Szczepanek <paul.szczepanek@arm.com> wrote:
>
> Alias used to produce the link to the DTS API docs uses config data.
> The required value in config data was being added in the wrong scope.
> This moves the key addition to where the config data object is created.
>
> Fixes: 7f9326423a04 ("dts: add API doc generation")
>
> Signed-off-by: Paul Szczepanek <paul.szczepanek@arm.com>
> Acked-by: Patrick Robb <probb@iol.unh.edu>
> ---
>  doc/api/dts/meson.build | 2 --
>  doc/api/meson.build     | 1 +
>  2 files changed, 1 insertion(+), 2 deletions(-)
>
> diff --git a/doc/api/dts/meson.build b/doc/api/dts/meson.build
> index 5115df7095..5cb4a68dd4 100644
> --- a/doc/api/dts/meson.build
> +++ b/doc/api/dts/meson.build
> @@ -11,8 +11,6 @@ if python_ver_satisfied != 0
>      subdir_done()
>  endif
>
> -cdata.set('DTS_API_MAIN_PAGE', join_paths('..', 'dts', 'html', 'index.html'))
> -
>  extra_sphinx_args = ['-E', '-c', join_paths(doc_source_dir, 'guides')]
>  if get_option('werror')
>      extra_sphinx_args += '-W'
> diff --git a/doc/api/meson.build b/doc/api/meson.build
> index ae23e9825e..fdb04e0ec8 100644
> --- a/doc/api/meson.build
> +++ b/doc/api/meson.build
> @@ -40,6 +40,7 @@ cdata.set('OUTPUT', join_paths(dpdk_build_root, 'doc', 'api'))
>  cdata.set('TOPDIR', dpdk_source_root)
>  cdata.set('STRIP_FROM_PATH', ' '.join([dpdk_source_root, join_paths(dpdk_build_root, 'doc', 'api')]))
>  cdata.set('WARN_AS_ERROR', 'NO')
> +cdata.set('DTS_API_MAIN_PAGE', join_paths(dpdk_build_root, 'doc', 'api', 'dts', 'html', 'index.html'))
>  if get_option('werror')
>      cdata.set('WARN_AS_ERROR', 'YES')
>  endif

Looking again while applying, something is fishy in doc/api/meson.build:

if not doxygen.found()
  # process DTS API doc build even if DPDK API doc build can't be done
  cdata = configuration_data()
  subdir('dts')
  subdir_done()
endif

Should this cdata (unused afaics) object be removed too?


-- 
David Marchand