From 2f020013e6b52cdc4d7e3a1c1d17f2f59699ee4e Mon Sep 17 00:00:00 2001
From: Mathieu Duponchelle <mathieu@centricular.com>
Date: Wed, 4 Jan 2023 21:37:55 +0100
Subject: [PATCH] docs: explicitly declare gir build dependencies

As the path to the gir file is passed to hotdoc.generate_doc() and
not the build target itself, meson doesn't know about the dependency.

In turn, as the CI doesn't build everything before building the
documentation target, some gir files might not exist, for instance
in the case of gst-rtsp-server, causing the output documentation to
be empty.

The error occurred silently because hotdoc accepts wildcards for
*-sources arguments, thus it won't warn about a missing gir file as
it is legitimate for glob matching to resolve to nothing.

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/3686>
---
 subprojects/gst-devtools/docs/meson.build         | 1 +
 subprojects/gst-editing-services/docs/meson.build | 1 +
 subprojects/gst-plugins-bad/docs/meson.build      | 1 +
 subprojects/gst-plugins-base/docs/meson.build     | 1 +
 subprojects/gst-rtsp-server/docs/meson.build      | 1 +
 subprojects/gstreamer/docs/meson.build            | 2 ++
 6 files changed, 7 insertions(+)

diff --git a/subprojects/gst-devtools/docs/meson.build b/subprojects/gst-devtools/docs/meson.build
index 560253e4cb..bff332831b 100644
--- a/subprojects/gst-devtools/docs/meson.build
+++ b/subprojects/gst-devtools/docs/meson.build
@@ -72,4 +72,5 @@ libs_doc = [hotdoc.generate_doc('gst-devtools',
     gi_sources: [validate_gir[0].full_path()],
     disable_incremental_build: true,
     dependencies : [validate_dep],
+    depends: validate_gir[0],
 )]
diff --git a/subprojects/gst-editing-services/docs/meson.build b/subprojects/gst-editing-services/docs/meson.build
index b2a1c7a684..2cee911c3b 100644
--- a/subprojects/gst-editing-services/docs/meson.build
+++ b/subprojects/gst-editing-services/docs/meson.build
@@ -108,6 +108,7 @@ libs_doc = [hotdoc.generate_doc('gst-editing-services',
     gi_order_generated_subpages: true,
     dependencies: [ges_dep],
     disable_incremental_build: true,
+    depends: ges_gir[0],
 )]
 
 plugins_doc = []
diff --git a/subprojects/gst-plugins-bad/docs/meson.build b/subprojects/gst-plugins-bad/docs/meson.build
index 9666e01a96..080419fe51 100644
--- a/subprojects/gst-plugins-bad/docs/meson.build
+++ b/subprojects/gst-plugins-bad/docs/meson.build
@@ -198,6 +198,7 @@ foreach lib_def: libs
                 dependencies: [lib, gir],
                 c_flags: '-DGST_USE_UNSTABLE_API',
                 install: false,
+                depends: gir[0],
             )]
         endif
     else
diff --git a/subprojects/gst-plugins-base/docs/meson.build b/subprojects/gst-plugins-base/docs/meson.build
index 7626def03a..f799db98f4 100644
--- a/subprojects/gst-plugins-base/docs/meson.build
+++ b/subprojects/gst-plugins-base/docs/meson.build
@@ -168,6 +168,7 @@ foreach lib: libs
       gi_order_generated_subpages: true,
       dependencies: deps,
       install: false,
+      depends: gir[0],
   )]
 endforeach
 
diff --git a/subprojects/gst-rtsp-server/docs/meson.build b/subprojects/gst-rtsp-server/docs/meson.build
index 0505a17390..b692cd0de5 100644
--- a/subprojects/gst-rtsp-server/docs/meson.build
+++ b/subprojects/gst-rtsp-server/docs/meson.build
@@ -91,6 +91,7 @@ libs_doc = [hotdoc.generate_doc('gst-rtsp-server',
     gi_index: 'index.md',
     gi_smart_index: true,
     gi_order_generated_subpages: true,
+    depends: rtsp_server_gir[0],
 )]
 
 plugins_doc = [hotdoc.generate_doc('rtspclientsink',
diff --git a/subprojects/gstreamer/docs/meson.build b/subprojects/gstreamer/docs/meson.build
index 3907d25c8b..4dad0d33b8 100644
--- a/subprojects/gstreamer/docs/meson.build
+++ b/subprojects/gstreamer/docs/meson.build
@@ -132,6 +132,7 @@ libs_doc = [hotdoc.generate_doc('gstreamer',
     gi_c_source_roots: [join_paths(meson.current_source_dir(), '../gst/'), ],
     dependencies: [gst_dep, gmodule_dep],
     extra_assets: [join_paths(meson.current_source_dir(), 'images')],
+    depends: gst_gir[0],
 )]
 
 libs = [
@@ -158,6 +159,7 @@ foreach lib: libs
       gi_order_generated_subpages: true,
       dependencies: deps,
       install: false,
+      depends: gir[0],
   )]
 endforeach