* [PATCH v2] doc: add examples.dox path to STRIP_FROM_PATH
@ 2021-11-23 14:47 Timothy Redaelli
2021-11-23 14:48 ` Timothy Redaelli
` (2 more replies)
0 siblings, 3 replies; 5+ messages in thread
From: Timothy Redaelli @ 2021-11-23 14:47 UTC (permalink / raw)
To: Ferruh Yigit, Thomas Monjalon; +Cc: Luca Boccassi, stable
examples.dox is built inside builddir/doc/api and so doxygen generates
some dir_HASH.html that includes the builddir name and this may prevent
DPDK documentation to be correctly generated in some distributions, for
example CentOS Stream 9 and RHEL9, since the builddir includes the
architecture.
This commit adds builddir/doc/api (the path where examples.dox is
generated) to STRIP_FROM_PATH, so the generated documentation doesn't
change if builddir changes.
Fixes: a6090630f4e5 ("doc: automate examples file list for API")
Cc: ferruh.yigit@intel.com
Cc: stable@dpdk.org
Signed-off-by: Timothy Redaelli <tredaelli@redhat.com>
---
v2:
- Don't use another VARIABLE name, but set STRIP_FROM_PATH with the 2
paths directly (suggested by David Marchand)
- Strip the full path of examples.dox (except the last component)
instead of stripping only build_root. This is needed since doxygen
generates the HASH of dir_HASH.html filename using the last component
of the path and so if the last part of buildroot is changed, the
filename is different.
---
doc/api/meson.build | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/doc/api/meson.build b/doc/api/meson.build
index d34c383694..7e2b429ac8 100644
--- a/doc/api/meson.build
+++ b/doc/api/meson.build
@@ -36,7 +36,7 @@ cdata.set('API_EXAMPLES', join_paths(meson.build_root(), 'doc', 'api', 'examples
cdata.set('OUTPUT', join_paths(meson.build_root(), 'doc', 'api'))
cdata.set('HTML_OUTPUT', 'html')
cdata.set('TOPDIR', meson.source_root())
-cdata.set('STRIP_FROM_PATH', meson.source_root())
+cdata.set('STRIP_FROM_PATH', ' '.join([meson.source_root(), join_paths(meson.build_root(), 'doc', 'api')]))
cdata.set('WARN_AS_ERROR', 'NO')
if get_option('werror')
cdata.set('WARN_AS_ERROR', 'YES')
--
2.33.1
^ permalink raw reply [flat|nested] 5+ messages in thread
* [PATCH v2] doc: add examples.dox path to STRIP_FROM_PATH
2021-11-23 14:47 [PATCH v2] doc: add examples.dox path to STRIP_FROM_PATH Timothy Redaelli
@ 2021-11-23 14:48 ` Timothy Redaelli
2021-11-23 15:16 ` Luca Boccassi
2021-11-23 19:39 ` David Marchand
2 siblings, 0 replies; 5+ messages in thread
From: Timothy Redaelli @ 2021-11-23 14:48 UTC (permalink / raw)
To: Ferruh Yigit, Thomas Monjalon; +Cc: Luca Boccassi, dev, stable
examples.dox is built inside builddir/doc/api and so doxygen generates
some dir_HASH.html that includes the builddir name and this may prevent
DPDK documentation to be correctly generated in some distributions, for
example CentOS Stream 9 and RHEL9, since the builddir includes the
architecture.
This commit adds builddir/doc/api (the path where examples.dox is
generated) to STRIP_FROM_PATH, so the generated documentation doesn't
change if builddir changes.
Fixes: a6090630f4e5 ("doc: automate examples file list for API")
Cc: ferruh.yigit@intel.com
Cc: stable@dpdk.org
Signed-off-by: Timothy Redaelli <tredaelli@redhat.com>
---
v2:
- Don't use another VARIABLE name, but set STRIP_FROM_PATH with the 2
paths directly (suggested by David Marchand)
- Strip the full path of examples.dox (except the last component)
instead of stripping only build_root. This is needed since doxygen
generates the HASH of dir_HASH.html filename using the last component
of the path and so if the last part of buildroot is changed, the
filename is different.
---
doc/api/meson.build | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/doc/api/meson.build b/doc/api/meson.build
index d34c383694..7e2b429ac8 100644
--- a/doc/api/meson.build
+++ b/doc/api/meson.build
@@ -36,7 +36,7 @@ cdata.set('API_EXAMPLES', join_paths(meson.build_root(), 'doc', 'api', 'examples
cdata.set('OUTPUT', join_paths(meson.build_root(), 'doc', 'api'))
cdata.set('HTML_OUTPUT', 'html')
cdata.set('TOPDIR', meson.source_root())
-cdata.set('STRIP_FROM_PATH', meson.source_root())
+cdata.set('STRIP_FROM_PATH', ' '.join([meson.source_root(), join_paths(meson.build_root(), 'doc', 'api')]))
cdata.set('WARN_AS_ERROR', 'NO')
if get_option('werror')
cdata.set('WARN_AS_ERROR', 'YES')
--
2.33.1
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [PATCH v2] doc: add examples.dox path to STRIP_FROM_PATH
2021-11-23 14:47 [PATCH v2] doc: add examples.dox path to STRIP_FROM_PATH Timothy Redaelli
2021-11-23 14:48 ` Timothy Redaelli
@ 2021-11-23 15:16 ` Luca Boccassi
2021-11-24 13:19 ` David Marchand
2021-11-23 19:39 ` David Marchand
2 siblings, 1 reply; 5+ messages in thread
From: Luca Boccassi @ 2021-11-23 15:16 UTC (permalink / raw)
To: Timothy Redaelli, Ferruh Yigit, Thomas Monjalon; +Cc: dev, stable
On Tue, 2021-11-23 at 15:48 +0100, Timothy Redaelli wrote:
> examples.dox is built inside builddir/doc/api and so doxygen generates
> some dir_HASH.html that includes the builddir name and this may prevent
> DPDK documentation to be correctly generated in some distributions, for
> example CentOS Stream 9 and RHEL9, since the builddir includes the
> architecture.
>
> This commit adds builddir/doc/api (the path where examples.dox is
> generated) to STRIP_FROM_PATH, so the generated documentation doesn't
> change if builddir changes.
>
> Fixes: a6090630f4e5 ("doc: automate examples file list for API")
> Cc: ferruh.yigit@intel.com
> Cc: stable@dpdk.org
> Signed-off-by: Timothy Redaelli <tredaelli@redhat.com>
> ---
> v2:
> - Don't use another VARIABLE name, but set STRIP_FROM_PATH with the 2
> paths directly (suggested by David Marchand)
> - Strip the full path of examples.dox (except the last component)
> instead of stripping only build_root. This is needed since doxygen
> generates the HASH of dir_HASH.html filename using the last component
> of the path and so if the last part of buildroot is changed, the
> filename is different.
> ---
> doc/api/meson.build | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/doc/api/meson.build b/doc/api/meson.build
> index d34c383694..7e2b429ac8 100644
> --- a/doc/api/meson.build
> +++ b/doc/api/meson.build
> @@ -36,7 +36,7 @@ cdata.set('API_EXAMPLES', join_paths(meson.build_root(), 'doc', 'api', 'examples
> cdata.set('OUTPUT', join_paths(meson.build_root(), 'doc', 'api'))
> cdata.set('HTML_OUTPUT', 'html')
> cdata.set('TOPDIR', meson.source_root())
> -cdata.set('STRIP_FROM_PATH', meson.source_root())
> +cdata.set('STRIP_FROM_PATH', ' '.join([meson.source_root(), join_paths(meson.build_root(), 'doc', 'api')]))
> cdata.set('WARN_AS_ERROR', 'NO')
> if get_option('werror')
> cdata.set('WARN_AS_ERROR', 'YES')
Acked-by: Luca Boccassi <bluca@debian.org>
--
Kind regards,
Luca Boccassi
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [PATCH v2] doc: add examples.dox path to STRIP_FROM_PATH
2021-11-23 14:47 [PATCH v2] doc: add examples.dox path to STRIP_FROM_PATH Timothy Redaelli
2021-11-23 14:48 ` Timothy Redaelli
2021-11-23 15:16 ` Luca Boccassi
@ 2021-11-23 19:39 ` David Marchand
2 siblings, 0 replies; 5+ messages in thread
From: David Marchand @ 2021-11-23 19:39 UTC (permalink / raw)
To: Timothy Redaelli
Cc: Ferruh Yigit, Thomas Monjalon, Luca Boccassi, dev, dpdk stable
On Tue, Nov 23, 2021 at 3:49 PM Timothy Redaelli <tredaelli@redhat.com> wrote:
>
> examples.dox is built inside builddir/doc/api and so doxygen generates
> some dir_HASH.html that includes the builddir name and this may prevent
> DPDK documentation to be correctly generated in some distributions, for
> example CentOS Stream 9 and RHEL9, since the builddir includes the
> architecture.
>
> This commit adds builddir/doc/api (the path where examples.dox is
> generated) to STRIP_FROM_PATH, so the generated documentation doesn't
> change if builddir changes.
>
> Fixes: a6090630f4e5 ("doc: automate examples file list for API")
> Cc: stable@dpdk.org
> Signed-off-by: Timothy Redaelli <tredaelli@redhat.com>
Tested-by: David Marchand <david.marchand@redhat.com>
--
David Marchand
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [PATCH v2] doc: add examples.dox path to STRIP_FROM_PATH
2021-11-23 15:16 ` Luca Boccassi
@ 2021-11-24 13:19 ` David Marchand
0 siblings, 0 replies; 5+ messages in thread
From: David Marchand @ 2021-11-24 13:19 UTC (permalink / raw)
To: Timothy Redaelli
Cc: Luca Boccassi, Ferruh Yigit, Thomas Monjalon, dev, dpdk stable
On Tue, Nov 23, 2021 at 4:17 PM Luca Boccassi <bluca@debian.org> wrote:
>
> On Tue, 2021-11-23 at 15:48 +0100, Timothy Redaelli wrote:
> > examples.dox is built inside builddir/doc/api and so doxygen generates
> > some dir_HASH.html that includes the builddir name and this may prevent
> > DPDK documentation to be correctly generated in some distributions, for
> > example CentOS Stream 9 and RHEL9, since the builddir includes the
> > architecture.
> >
> > This commit adds builddir/doc/api (the path where examples.dox is
> > generated) to STRIP_FROM_PATH, so the generated documentation doesn't
> > change if builddir changes.
> >
> > Fixes: a6090630f4e5 ("doc: automate examples file list for API")
> > Cc: stable@dpdk.org
> > Signed-off-by: Timothy Redaelli <tredaelli@redhat.com>
> Acked-by: Luca Boccassi <bluca@debian.org>
Tested-by: David Marchand <david.marchand@redhat.com>
Applied, thanks.
--
David Marchand
^ permalink raw reply [flat|nested] 5+ messages in thread
end of thread, other threads:[~2021-11-24 13:19 UTC | newest]
Thread overview: 5+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-11-23 14:47 [PATCH v2] doc: add examples.dox path to STRIP_FROM_PATH Timothy Redaelli
2021-11-23 14:48 ` Timothy Redaelli
2021-11-23 15:16 ` Luca Boccassi
2021-11-24 13:19 ` David Marchand
2021-11-23 19:39 ` 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).