GNOME Bugzilla – Bug 742404
unify index.sgml and *.devhelp2 + change gtkdoc-fixxref to use *.devhelp2
Last modified: 2015-06-24 12:39:24 UTC
index.sgml is not sgml and is only used by fixxref. Most of the info is in *.devhelp2 as well: index.sgml: <ONLINE href="http://[SERVER]/tester/index.html"> <ANCHOR id="GtkdocObject" href="tester/GtkdocObject.html"> grep -o "<keyword.*" tester.devhelp2 <keyword type="" name="Examples" link="GtkdocObject.html#examples"/> <keyword type="" name="Discussion" link="GtkdocObject.html#id-1.4.2.2.8.11"/> <keyword type="" name="Coda" link="GtkdocObject.html#this-is-an-id-tag"/> <keyword type="function" name="gtkdoc_object_new ()" link="GtkdocObject.html#gtkdoc-object-new" since="0.1"/> This would make building a bit faster and ensure that what we xref also appears in devhelp (see #736073).
Both files are generated from gtkdoc.xsl: <!-- generate the index.sgml href index --> <xsl:call-template name="generate.index"/> <!-- generate $book.devhelp2 --> <xsl:call-template name="generate.devhelp2"/> The changes needed would be: - add missing details to devhelp2 files - make gtkdoc-fixxref and gtkdoc-rebase read devhelp2 files and fallback to index.sgml if the data is not present in devhelp2 files - after some grace period, drop the index.sgml files and the code that uses them
One problem, ubuntu is gzipping the devhelp2 files :/ https://bugs.launchpad.net/ubuntu/+source/glib2.0/+bug/1466210
Created attachment 305588 [details] [review] stop generating index.sgml files Just in case anyone wants to test.
commit 3a3d70d24217c2ea7197d50363ea82908e3d5473 Author: Stefan Sauer <ensonic@users.sf.net> Date: Wed Jun 17 22:53:43 2015 +0200 index.sgml: stop generating index.sgml files Use the data from devhelp2 files. Saves diskspace and makes the html phase about 10% faster. Fixes #742404