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 661032 - out-of-tree builds result in broken gtk-doc documentation
out-of-tree builds result in broken gtk-doc documentation
Status: RESOLVED FIXED
Product: gtk+
Classification: Platform
Component: Documentation
2.24.x
Other Linux
: Normal normal
: ---
Assigned To: gtk-bugs
gtk-bugs
Depends on:
Blocks:
 
 
Reported: 2011-10-05 22:44 UTC by Michael Biebl
Modified: 2011-10-21 20:28 UTC
See Also:
GNOME target: ---
GNOME version: ---

Attachments
"Index of all symbols" html file (3.86 KB, text/html)
2011-10-05 22:45 UTC, Michael Biebl 		  Details
build log (456.05 KB, application/x-gzip)
2011-10-05 22:46 UTC, Michael Biebl 		  Details
proposed patch (2.00 KB, patch)
2011-10-21 14:52 UTC, Sjoerd Simons 		none Details | Review
Fix document generation in out of tree builds (2.04 KB, patch)
2011-10-21 20:28 UTC, Matthias Clasen 		committed Details | Review

Description Michael Biebl 2011-10-05 22:44:41 UTC 
When building gtk+ with srcdir!=builddir and using --enable-gtk-doc, the resulting files are broken/not complete.

E.g. the index files are incomplete. See the attached "Index of all symbols" as an example.

I've also attached the complete build log.

There are lots of warnings about missing declarations:

  DOC   Rebuilding template files
./gtk-sections.txt:7: warning: No declaration found for: GtkAboutDialog
./gtk-sections.txt:8: warning: No declaration found for: gtk_about_dialog_new
...

It also doesn't seem to find xml files:

  DOC   Building HTML
warning: failed to load external entity "../xml/api-index-2.2.xml"
warning: failed to load external entity "../xml/api-index-2.4.xml"
warning: failed to load external entity "../xml/api-index-2.6.xml"
warning: failed to load external entity "../xml/api-index-2.8.xml"
warning: failed to load external entity "../xml/api-index-2.10.xml"
warning: failed to load external entity "../xml/api-index-2.12.xml"
warning: failed to load external entity "../xml/api-index-2.14.xml"
warning: failed to load external entity "../xml/api-index-2.16.xml"
warning: failed to load external entity "../xml/api-index-2.18.xml"
warning: failed to load external entity "../xml/api-index-2.20.xml"
warning: failed to load external entity "../xml/api-index-2.22.xml"
warning: failed to load external entity "../xml/api-index-2.24.xml"
warning: failed to load external entity "../xml/annotation-glossary.xml"
Comment 1 Michael Biebl 2011-10-05 22:45:29 UTC 
Created attachment 198384 [details]
"Index of all symbols" html file
Comment 2 Michael Biebl 2011-10-05 22:46:01 UTC 
Created attachment 198385 [details]
build log
Comment 3 Matthias Clasen 2011-10-07 19:11:52 UTC 
-> gtk-doc ?
Comment 4 Michael Biebl 2011-10-07 20:13:02 UTC 
(In reply to comment #3)
> -> gtk-doc ?

Dunno really if this is a bug in gtk-doc or the way gtk+ uses gtkdoc.
Comment 5 Sjoerd Simons 2011-10-21 14:52:33 UTC 
Created attachment 199649 [details] [review]
proposed patch
Comment 6 Matthias Clasen 2011-10-21 20:28:24 UTC 
The following fix has been pushed:
958fc69 Fix document generation in out of tree builds
Comment 7 Matthias Clasen 2011-10-21 20:28:27 UTC 
Created attachment 199699 [details] [review]
Fix document generation in out of tree builds