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 749591 - gtk-doc 1.23 no longer includes xml namespace in .devhelp2 files
gtk-doc 1.23 no longer includes xml namespace in .devhelp2 files
Status: RESOLVED FIXED
Product: gtk-doc
Classification: Platform
Component: general
1.23
Other Linux
: Normal major
: 1.24
Assigned To: gtk-doc maintainers
gtk-doc maintainers
Depends on:
Blocks:
 
 
Reported: 2015-05-19 17:02 UTC by dalcde
Modified: 2015-05-19 19:14 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
patch (2.75 KB, patch)
2015-05-19 17:02 UTC, dalcde
none Details | Review

Description dalcde 2015-05-19 17:02:15 UTC
Created attachment 303613 [details] [review]
patch

When devhelp is loading a .devhelp2 file, it checks that the xml namepsace is set to http://www.devhelp.net/book. If it is not, devhelp refuses to load the relevant documentation. However, the xml namespace attribute is no longer set by gtk-doc 1.23 and devhelp will refuse to load anything compiled with it.

I don't see any reason why this check should exist at all. No sane person who would ever put a random .devhelp2 file into /usr/share/gtk-doc/html if it is not a doc. Even if such a file existed, there wouldn't be much bad consequences if you loaded it. So there is no reason to refuse to load a .devhelp2 file with improper namespace. The check won't complain if the xmlns attribute is not set at all, so it is useless as a validity check.

A less relevant reason is that http://www.devhelp.net/book is not even a real site at all. When I attempt to access it, various redirects send me to a scam site telling me I can buy an iPhone 6 for only 1 pound (this seems to be region-dependent). So I guess it is a better idea not to put this link into our doc files.

Attached is a patch that removes the relevant check.
Comment 1 Frederic Peters 2015-05-19 17:18:48 UTC
I would much prefer for gtk-doc to add back the namespace, its removal will also break the developer.gnome.org website (it looks for <keyword> elements attached to that namespace).

(a namespace qualifies a node name, it doesn't have to be a real site (it looks like it did exist when it was introduced, more than ten years ago)).
Comment 2 Stefan Sauer (gstreamer, gtkdoc dev) 2015-05-19 19:02:56 UTC
commit a0b6f5b205968a446f2116deeb2ef3ce0b56c60f
Author: Stefan Sauer <ensonic@users.sf.net>
Date:   Tue May 19 21:00:24 2015 +0200

    devhelp: readd the xml namespace
    
    Inline the xsd attributes. Apparently unqualified attribute namespaces don't
    work with referenced attributes.