gstreamer1.0-libav: enable gtk-doc again

Message ID 20190909153236.28042-1-ross.burton@intel.com
State Accepted
Commit 25a0d1b0b14a4fcd41ca08084a2f22db54dec58e
Headers show
Series
  • gstreamer1.0-libav: enable gtk-doc again
Related show

Commit Message

Ross Burton Sept. 9, 2019, 3:32 p.m.
Remove the broken piece of the API documentation template so the documentation
can be generated again.

Signed-off-by: Ross Burton <ross.burton@intel.com>

---
 .../gstreamer1.0-libav/gtkdoc-no-tree.patch   | 24 +++++++++++++++++++
 .../gstreamer/gstreamer1.0-libav_1.16.0.bb    |  6 +----
 2 files changed, 25 insertions(+), 5 deletions(-)
 create mode 100644 meta/recipes-multimedia/gstreamer/gstreamer1.0-libav/gtkdoc-no-tree.patch

-- 
2.20.1

-- 
_______________________________________________
Openembedded-core mailing list
Openembedded-core@lists.openembedded.org
http://lists.openembedded.org/mailman/listinfo/openembedded-core

Patch

diff --git a/meta/recipes-multimedia/gstreamer/gstreamer1.0-libav/gtkdoc-no-tree.patch b/meta/recipes-multimedia/gstreamer/gstreamer1.0-libav/gtkdoc-no-tree.patch
new file mode 100644
index 00000000000..5ea9232c265
--- /dev/null
+++ b/meta/recipes-multimedia/gstreamer/gstreamer1.0-libav/gtkdoc-no-tree.patch
@@ -0,0 +1,24 @@ 
+gtk-doc can't find a type hierarchy when scanning gst-libav, and the new gtk-doc
+doesn't write a file if it will be empty. This results in the gtk-doc generation
+failing.
+
+This could be investigated further but upstream has moved away from gtk-doc, so
+in the next release this will be moot anyway.
+
+Upstream-Status: Inappropriate [upstream moved away from gtk-doc]
+Signed-off-by: Ross Burton <ross.burton@intel.com>
+
+diff --git a/docs/plugins/gst-libav-plugins-docs.sgml b/docs/plugins/gst-libav-plugins-docs.sgml
+index 75c68f4..f68d554 100644
+--- a/docs/plugins/gst-libav-plugins-docs.sgml
++++ b/docs/plugins/gst-libav-plugins-docs.sgml
+@@ -32,9 +32,4 @@
+     <title>gst-libav Plugins</title>
+     <xi:include href="xml/plugin-libav.xml" />
+   </chapter>
+-
+-  <chapter>
+-    <title>Object Hierarchy</title>
+-    <xi:include href="xml/tree_index.sgml" />
+-  </chapter>
+ </book>
diff --git a/meta/recipes-multimedia/gstreamer/gstreamer1.0-libav_1.16.0.bb b/meta/recipes-multimedia/gstreamer/gstreamer1.0-libav_1.16.0.bb
index d94c3215dc4..d2629b506d7 100644
--- a/meta/recipes-multimedia/gstreamer/gstreamer1.0-libav_1.16.0.bb
+++ b/meta/recipes-multimedia/gstreamer/gstreamer1.0-libav_1.16.0.bb
@@ -18,6 +18,7 @@  SRC_URI = "http://gstreamer.freedesktop.org/src/gst-libav/gst-libav-${PV}.tar.xz
            file://mips64_cpu_detection.patch \
            file://0001-configure-check-for-armv7ve-variant.patch \
            file://0001-fix-host-contamination.patch \
+           file://gtkdoc-no-tree.patch \
            "
 SRC_URI[md5sum] = "e3a201a45985ddc1327cd496046ca818"
 SRC_URI[sha256sum] = "dfac119043a9cfdcacd7acde77f674ab172cf2537b5812be52f49e9cddc53d9a"
@@ -28,11 +29,6 @@  DEPENDS = "gstreamer1.0 gstreamer1.0-plugins-base zlib bzip2 xz"
 
 inherit autotools pkgconfig upstream-version-is-even gtk-doc
 
-# Disable documentation for now as it is failing with gtk-doc 1.30:
-# gst-libav-plugins-docs.sgml:38: element include: XInclude error:
-# could not load xml/tree_index.sgml, and no fallback was found
-GTKDOC_ENABLED = "False"
-
 # CAUTION: Using the system libav is not recommended. Since the libav API is changing all the time,
 # compilation errors (and other, more subtle bugs) can happen. It is usually better to rely on the
 # libav copy included in the gst-libav package.