gtk-doc build fails after gtk-doc 1.26
Brought to you by:
mnauw
Menu
▾
▴
#8 gtk-doc build fails after gtk-doc 1.26
Unfortunately, trying to build the GTK docs for GEntrans fails with recent versions of gtk-doc. It seems that gtk-doc deprecated the use of template files a while ago, and removed support for them altogether in 1.26, breaking most older build setups in the process (as the gtkdoc-mktmpl command no longer exists).
Some documentation on the change is here: https://developer.gnome.org/gtk-doc-manual/stable/modernizing-gtk-doc-1-9.html.en
Documentation on defining sections in source instead of template files is here:
https://developer.gnome.org/gtk-doc-manual/stable/documenting_sections.html.en
(I'm not too familiar with gtk-doc myself, so apologies if that's a bit sparse or not too useful.)
As a short term workaround for packaging in Fedora, I've attempted to swap out the base and GStreamer gtk-doc makefiles to current versions. However, even without calling gtkdoc-mktmpl, the build does subsequently complain about undefined sections, so I guess I'm not getting off that easy. :(
I'm not all that familiar with gtk-doc either, but after a closer look at base GStreamer gtk-doc handling, I made corresponding changes to remove dependency on gtkdoc-mktmpl. It seems to work for me. If it really also works in general, this may then be as good a time as any to come up with another release ...
Thanks for the quick response. :)
I've had to make one small change to common/gtk-doc-plugins.mak - apparently gtkdoc-fixxref requires a --module argument now (possibly a recent change?), so I borrowed the call from GStreamer upstream's current git revision. The relevant patch is attached.
From my preliminary testing, with that change this does seem to build and function correctly on Fedora 28, with docs all generated and in good shape. I'm happy to either backport just the build fixes or push a new release in Fedora, at your discretion.
Thanks for the patch. I included it and made a new release, which should then be good to go.