[PATCH v2] docs: ensure HTML/images are built before running reference tests

Daniel P. Berrangé posted 1 patch 1 year, 9 months ago
Patches applied successfully (tree, apply log)
git fetch https://github.com/patchew-project/libvirt tags/patchew/20240508160642.1266155-1-berrange@redhat.com
docs/images/meson.build | 3 ++-
docs/logos/meson.build  | 3 ++-
docs/meson.build        | 1 +
3 files changed, 5 insertions(+), 2 deletions(-)
[PATCH v2] docs: ensure HTML/images are built before running reference tests
Posted by Daniel P. Berrangé 1 year, 9 months ago
The 'check-html-references' test will process the built HTML files,
so they must exist before it is run, along with any images that
they point to.

If using the older 'configure_file' command, no changes are needed
since that always gets executed at 'meson setup' time, rather than
at 'meson compile' time.

Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
---
 docs/images/meson.build | 3 ++-
 docs/logos/meson.build  | 3 ++-
 docs/meson.build        | 1 +
 3 files changed, 5 insertions(+), 2 deletions(-)

This is the only remaining unpushed patch from my previous v1
series, now I figured out how to make it compatible with old
meson (see last sentence in the commit message)

diff --git a/docs/images/meson.build b/docs/images/meson.build
index b9ab30fc91..f3e3dd50da 100644
--- a/docs/images/meson.build
+++ b/docs/images/meson.build
@@ -18,7 +18,8 @@ foreach file : docs_image_files
   # This hack enables us to view the web pages
   # from within the uninstalled build tree
   if meson.version().version_compare('>=0.64.0')
-    fs.copyfile(file)
+    imgfile = fs.copyfile(file)
+    install_web_deps += imgfile
   else
     configure_file(input: file, output: file, copy: true)
   endif
diff --git a/docs/logos/meson.build b/docs/logos/meson.build
index c3f4c9f522..2d9d0fcbb0 100644
--- a/docs/logos/meson.build
+++ b/docs/logos/meson.build
@@ -26,7 +26,8 @@ foreach file : docs_logo_files
   # This hack enables us to view the web pages
   # from within the uninstalled build tree
   if meson.version().version_compare('>=0.64.0')
-    fs.copyfile(file)
+    logofile = fs.copyfile(file)
+    install_web_deps += logofile
   else
     configure_file(input: file, output: file, copy: true)
   endif
diff --git a/docs/meson.build b/docs/meson.build
index 87d728213c..2dfe98ef62 100644
--- a/docs/meson.build
+++ b/docs/meson.build
@@ -360,6 +360,7 @@ if tests_enabled[0]
       '--webroot',
       meson.project_build_root() / 'docs'
     ],
+    depends: install_web_deps,
     env: runutf8,
     suite: 'script'
   )
-- 
2.43.0
_______________________________________________
Devel mailing list -- devel@lists.libvirt.org
To unsubscribe send an email to devel-leave@lists.libvirt.org
Re: [PATCH v2] docs: ensure HTML/images are built before running reference tests
Posted by Michal Prívozník 1 year, 9 months ago
On 5/8/24 18:06, Daniel P. Berrangé wrote:
> The 'check-html-references' test will process the built HTML files,
> so they must exist before it is run, along with any images that
> they point to.
> 
> If using the older 'configure_file' command, no changes are needed
> since that always gets executed at 'meson setup' time, rather than
> at 'meson compile' time.
> 
> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
> ---
>  docs/images/meson.build | 3 ++-
>  docs/logos/meson.build  | 3 ++-
>  docs/meson.build        | 1 +
>  3 files changed, 5 insertions(+), 2 deletions(-)
> 
> This is the only remaining unpushed patch from my previous v1
> series, now I figured out how to make it compatible with old
> meson (see last sentence in the commit message)
> 
> diff --git a/docs/images/meson.build b/docs/images/meson.build
> index b9ab30fc91..f3e3dd50da 100644
> --- a/docs/images/meson.build
> +++ b/docs/images/meson.build
> @@ -18,7 +18,8 @@ foreach file : docs_image_files
>    # This hack enables us to view the web pages
>    # from within the uninstalled build tree
>    if meson.version().version_compare('>=0.64.0')
> -    fs.copyfile(file)
> +    imgfile = fs.copyfile(file)
> +    install_web_deps += imgfile
>    else
>      configure_file(input: file, output: file, copy: true)
>    endif
> diff --git a/docs/logos/meson.build b/docs/logos/meson.build
> index c3f4c9f522..2d9d0fcbb0 100644
> --- a/docs/logos/meson.build
> +++ b/docs/logos/meson.build
> @@ -26,7 +26,8 @@ foreach file : docs_logo_files
>    # This hack enables us to view the web pages
>    # from within the uninstalled build tree
>    if meson.version().version_compare('>=0.64.0')
> -    fs.copyfile(file)
> +    logofile = fs.copyfile(file)
> +    install_web_deps += logofile
>    else
>      configure_file(input: file, output: file, copy: true)
>    endif
> diff --git a/docs/meson.build b/docs/meson.build
> index 87d728213c..2dfe98ef62 100644
> --- a/docs/meson.build
> +++ b/docs/meson.build
> @@ -360,6 +360,7 @@ if tests_enabled[0]
>        '--webroot',
>        meson.project_build_root() / 'docs'
>      ],
> +    depends: install_web_deps,
>      env: runutf8,
>      suite: 'script'
>    )

Reviewed-by: Michal Privoznik <mprivozn@redhat.com>

Michal
_______________________________________________
Devel mailing list -- devel@lists.libvirt.org
To unsubscribe send an email to devel-leave@lists.libvirt.org