* [PATCH] dts: fix doxygen API link
@ 2024-10-23 14:57 Paul Szczepanek
2024-10-23 15:00 ` Luca Vizzarro
` (2 more replies)
0 siblings, 3 replies; 6+ messages in thread
From: Paul Szczepanek @ 2024-10-23 14:57 UTC (permalink / raw)
To: dev; +Cc: probb, Paul Szczepanek
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
--
2.39.2
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH] dts: fix doxygen API link
2024-10-23 14:57 [PATCH] dts: fix doxygen API link Paul Szczepanek
@ 2024-10-23 15:00 ` Luca Vizzarro
2024-10-23 15:07 ` David Marchand
2024-10-23 15:30 ` David Marchand
2 siblings, 0 replies; 6+ messages in thread
From: Luca Vizzarro @ 2024-10-23 15:00 UTC (permalink / raw)
To: Paul Szczepanek, dev; +Cc: probb
Reviewed-by: Luca Vizzarro <luca.vizzarro@arm.com>
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH] dts: fix doxygen API link
2024-10-23 14:57 [PATCH] dts: fix doxygen API link Paul Szczepanek
2024-10-23 15:00 ` Luca Vizzarro
@ 2024-10-23 15:07 ` David Marchand
2024-10-23 15:10 ` Patrick Robb
2024-10-23 15:30 ` David Marchand
2 siblings, 1 reply; 6+ messages in thread
From: David Marchand @ 2024-10-23 15:07 UTC (permalink / raw)
To: Paul Szczepanek, probb; +Cc: dev
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>
Good timing, I was about to send a report about this warning.
This makes the warning disappear (and the dts doc generates).
Tested-by: David Marchand <david.marchand@redhat.com>
Patrick, I'll merge it directly in main, is that ok for you?
--
David Marchand
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH] dts: fix doxygen API link
2024-10-23 15:07 ` David Marchand
@ 2024-10-23 15:10 ` Patrick Robb
0 siblings, 0 replies; 6+ messages in thread
From: Patrick Robb @ 2024-10-23 15:10 UTC (permalink / raw)
To: David Marchand; +Cc: Paul Szczepanek, dev
Yes that's fine thanks David!
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH] dts: fix doxygen API link
2024-10-23 14:57 [PATCH] dts: fix doxygen API link Paul Szczepanek
2024-10-23 15:00 ` Luca Vizzarro
2024-10-23 15:07 ` David Marchand
@ 2024-10-23 15:30 ` David Marchand
2024-10-24 9:12 ` David Marchand
2 siblings, 1 reply; 6+ messages in thread
From: David Marchand @ 2024-10-23 15:30 UTC (permalink / raw)
To: Paul Szczepanek, probb; +Cc: dev, Luca Vizzarro
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
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH] dts: fix doxygen API link
2024-10-23 15:30 ` David Marchand
@ 2024-10-24 9:12 ` David Marchand
0 siblings, 0 replies; 6+ messages in thread
From: David Marchand @ 2024-10-24 9:12 UTC (permalink / raw)
To: Paul Szczepanek, probb; +Cc: dev, Luca Vizzarro, Thomas Monjalon
On Wed, Oct 23, 2024 at 5:30 PM David Marchand
<david.marchand@redhat.com> wrote:
>
> 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?
It seems there are more issues with the doc generation.
Looking at dpdk.org documentation (https://doc.dpdk.org/api/), there
is a dead link to DTS at the bottom of the page:
tests: [DTS]()
The documentation for dts should be generated to dpdk_build_root
/doc/api/html/dts
And I think the link should be a relative one, like
cdata.set('DTS_API_MAIN_PAGE', join_paths('dts', 'index.html'))
Please have a look.
--
David Marchand
^ permalink raw reply [flat|nested] 6+ messages in thread
end of thread, other threads:[~2024-10-24 9:13 UTC | newest]
Thread overview: 6+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2024-10-23 14:57 [PATCH] dts: fix doxygen API link Paul Szczepanek
2024-10-23 15:00 ` Luca Vizzarro
2024-10-23 15:07 ` David Marchand
2024-10-23 15:10 ` Patrick Robb
2024-10-23 15:30 ` David Marchand
2024-10-24 9:12 ` David Marchand
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).