GNOME Bugzilla – Bug 543854
glib-2.16.5 release fails doc rebuild with gtk-doc-1.10 release because it was prepared with an unreleased gtk-doc-1.11
Last modified: 2008-09-22 10:34:51 UTC
As per http://bugs.gentoo.org/show_bug.cgi?id=232417 glib-2.16.5 fails to compile on building documentation: touch sgml-build.stamp gtk-doc: Building HTML rm -rf ./html mkdir ./html cd ./html && gtkdoc-mkhtml --path="." glib ../glib-docs.sgml Usage: gtkdoc-mkhtml MODULE DRIVER_FILE make[4]: *** [html-build.stamp] Error 1 make[4]: Leaving directory `/var/tmp/portage/dev-libs/glib-2.16.5/work/glib-2.16.5/docs/reference/glib' It seems this broke backwards compatibility with older gtk-doc on system: http://svn.gnome.org/viewvc/gtk-doc?view=revision&revision=591 Note that I volunteered for making releases and I can do them with gtk-doc-1.10 to avoid problems from this kind of SVN snapshot build tool usages
I've filed Bug 543855 against gtk-doc to ensure the eventual gtk-doc-1.11 release won't mean all tarballs built with it will require gtk-doc-1.11 as a build dependency if --enable-gtk-doc is passed, which would be not that good for us in Gentoo
--enable-gtk-doc is not really recommended when building from tarballs, anyway. There is a reason we include generated docs in the tarballs...
(In reply to comment #2) > --enable-gtk-doc is not really recommended when building from tarballs, anyway. > There is a reason we include generated docs in the tarballs... And it's probably not really recommended to use a development snapshot of a build tool for building tarballs, anyway. So what's the plan now? If you say there are absolutely zero benefits in rebuilding the docs (I believe cross-linking to other docs now works without a rebuild with gtk-doc-1.10), I guess we can remove the doc rebuild possibility when installing from source, but I think there are some benefits, especially in the future for a given version when a new gtk-doc release comes out for instance that adds features that can be benefitted from from a simple rebuild
> And it's probably not really recommended to use a development snapshot of a > build tool for building tarballs, anyway. So what's the plan now? It was an accident, and would not normally have happened. > If you say there are absolutely zero benefits in rebuilding the docs Rebuilding the docs causes multilib conflicts because libxslt uses memory addresses for generated ids. That may not be an issue for Gentoo...
Haven't seen any issues on amd64, but maybe it's subtle and need to know more about the issue to know for sure. Anyhow, this can be discussed separately and I think we can consider this bug fixed with the release of glib-2.16.6 that had docs built with a good gtk-doc-1.10