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 736073 - Regression: problems with enum constants
Regression: problems with enum constants
Status: RESOLVED FIXED
Product: gtk-doc
Classification: Platform
Component: general
1.21
Other Linux
: Normal major
: 1.22
Assigned To: gtk-doc maintainers
gtk-doc maintainers
Depends on:
Blocks:
 
 
Reported: 2014-09-04 17:11 UTC by Sébastien Wilmet
Modified: 2015-01-05 17:53 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
gtkdoc.xsl: fix index selector optimization (985 bytes, patch)
2015-01-04 18:38 UTC, Stefan Sauer (gstreamer, gtkdoc dev)
committed Details | Review

Description Sébastien Wilmet 2014-09-04 17:11:14 UTC
When building the GtkSourceView documentation, I see the following warnings:

>  DOC   Fixing cross-references
> html/GtkSourceCompletionInfo.html:91: warning: no link for: 'G-SIGNAL-ACTION:CAPS' -> (Action).
> html/GtkSourceGutterRenderer.html:305: warning: no link for: 'G-SIGNAL-RUN-LAST:CAPS' -> (Run Last).
> html/GtkSourceCompletion.html:917: warning: no link for: 'GTK-SCROLL-PAGES:CAPS' -> (<code class="literal">GTK_SCROLL_PAGES</code>).

For G_SIGNAL_ACTION and G_SIGNAL_RUN_LAST, it comes from the signal definition.

For GTK_SCROLL_PAGES, it comes from a reference in a GTK-Doc comment: %GTK_SCROLL_PAGES.

When generating the GtkSourceView doc with the latest GTK-Doc version from git, if the cross-references are fixed against the html docs that I install from my Linux distro (GTK+ 3.8 and GLib 2.36, generated with an older GTK-Doc), everything is fine.

If I compile the latest GTK+ and GLib docs with the latest GTK-Doc, all from git with jhbuild, then I have the warnings.

So the problem probably doesn't come from gtkdoc-fixxref, but from the "available" symbols in GTK+ and GLib.

Probably the same problem, if I search G_SIGNAL_ACTION in devhelp, the symbol isn't found (it worked before).
Comment 1 Sébastien Wilmet 2015-01-04 14:05:16 UTC
It's a quite major problem, since lots of symbols are not available when searching them in devhelp.
Comment 2 Stefan Sauer (gstreamer, gtkdoc dev) 2015-01-04 17:52:58 UTC
I don't want to play this down, but I simply did not yet had time to investigate. If you want to ping a bug, please use IRC.
Comment 3 Stefan Sauer (gstreamer, gtkdoc dev) 2015-01-04 18:04:58 UTC
Sébastien, what do you get when you run this:

grep "G-SIGNAL" /usr/share/gtk-doc/html/gobject/index.sgml
<ANCHOR id="G-SIGNAL-TYPE-STATIC-SCOPE:CAPS" href="gobject/gobject-Signals.html#G-SIGNAL-TYPE-STATIC-SCOPE:CAPS">
<ANCHOR id="G-SIGNAL-MATCH-MASK:CAPS" href="gobject/gobject-Signals.html#G-SIGNAL-MATCH-MASK:CAPS">
<ANCHOR id="G-SIGNAL-FLAGS-MASK:CAPS" href="gobject/gobject-Signals.html#G-SIGNAL-FLAGS-MASK:CAPS">

Those docs where generated by gtk-doc 1.20 and don't contan the enum values either.
grep "Generated by" /usr/share/gtk-doc/html/gobject/index.html 
          Generated by GTK-Doc V1.20</div>

Which version generated your?
Comment 4 Sébastien Wilmet 2015-01-04 18:20:26 UTC
I don't have a Fedora 19 around anymore, but from what I've tested the symbols were present in the docs installed from the packages of Fedora 19 (with GTK+ 3.8).
Comment 5 Stefan Sauer (gstreamer, gtkdoc dev) 2015-01-04 18:38:14 UTC
The following fix has been pushed:
68140b1 gtkdoc.xsl: fix index selector optimization
Comment 6 Stefan Sauer (gstreamer, gtkdoc dev) 2015-01-04 18:38:18 UTC
Created attachment 293716 [details] [review]
gtkdoc.xsl: fix index selector optimization

The index selector was missing para tags. Those wrap e.g. enum entries.

Fixes #736073
Comment 7 Sébastien Wilmet 2015-01-04 20:57:33 UTC
Thanks, the warnings when compiling the GtkSourceView documentation have now disappeared.

But I still cannot search G_SIGNAL_ACTION in devhelp, I'm not sure if it's a gtk-doc or devhelp problem.
Comment 8 Stefan Sauer (gstreamer, gtkdoc dev) 2015-01-05 17:53:41 UTC
This was broken with the markdown changes. We should unify index.sgml and index.devhelp2 - that is make gtkdoc-fixxref use the index.devhelp2 as well. Filed #742404

commit 6d82b2651bac715be19a4d5fbb03052a6c000549
Author: Stefan Sauer <ensonic@users.sf.net>
Date:   Mon Jan 5 18:44:04 2015 +0100

    devhelp: fix missing enum values
    
    When changing the layout with the markup parser we broke the constants.