After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 742404 - unify index.sgml and *.devhelp2 + change gtkdoc-fixxref to use *.devhelp2
unify index.sgml and *.devhelp2 + change gtkdoc-fixxref to use *.devhelp2
Status: RESOLVED FIXED
Product: gtk-doc
Classification: Platform
Component: general
unspecified
Other Linux
: Normal enhancement
: 1.25
Assigned To: gtk-doc maintainers
gtk-doc maintainers
Depends on:
Blocks:
 
 
Reported: 2015-01-05 17:52 UTC by Stefan Sauer (gstreamer, gtkdoc dev)
Modified: 2015-06-24 12:39 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
stop generating index.sgml files (13.61 KB, patch)
2015-06-18 14:14 UTC, Stefan Sauer (gstreamer, gtkdoc dev)
none Details | Review

Description Stefan Sauer (gstreamer, gtkdoc dev) 2015-01-05 17:52:40 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).
Comment 1 Stefan Sauer (gstreamer, gtkdoc dev) 2015-05-07 10:54:35 UTC
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
Comment 2 Stefan Sauer (gstreamer, gtkdoc dev) 2015-06-17 20:22:02 UTC
One problem, ubuntu is gzipping the devhelp2 files :/
https://bugs.launchpad.net/ubuntu/+source/glib2.0/+bug/1466210
Comment 3 Stefan Sauer (gstreamer, gtkdoc dev) 2015-06-18 14:14:34 UTC
Created attachment 305588 [details] [review]
stop generating index.sgml files

Just in case anyone wants to test.
Comment 4 Stefan Sauer (gstreamer, gtkdoc dev) 2015-06-24 12:39:24 UTC
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