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 688418 - Building g-i reference docs has a few issues
Building g-i reference docs has a few issues
Status: RESOLVED FIXED
Product: gobject-introspection
Classification: Platform
Component: general
unspecified
Other All
: Normal normal
: ---
Assigned To: gobject-introspection Maintainer(s)
gobject-introspection Maintainer(s)
Depends on:
Blocks:
 
 
Reported: 2012-11-15 19:40 UTC by Dieter Verfaillie
Modified: 2015-02-07 17:02 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
docs: make gtkdoc-mkdb ignore cmph doxygen comment blocks. (1.06 KB, patch)
2012-11-15 19:41 UTC, Dieter Verfaillie
none Details | Review
docs: remove reference to object_grouped.sgml. (2.14 KB, patch)
2012-11-15 19:42 UTC, Dieter Verfaillie
none Details | Review
docs: don't mark non GTK-Doc as being a GTK-Doc comment block (918 bytes, patch)
2012-11-15 19:43 UTC, Dieter Verfaillie
none Details | Review
docs: add GTK-Doc generated output to .gitignore (953 bytes, patch)
2012-11-15 19:44 UTC, Dieter Verfaillie
none Details | Review
docs: make gtkdoc-mkdb ignore cmph doxygen comment blocks. (1.11 KB, patch)
2012-11-15 20:06 UTC, Dieter Verfaillie
committed Details | Review
docs: remove reference to object_grouped.sgml. (2.19 KB, patch)
2012-11-15 20:06 UTC, Dieter Verfaillie
committed Details | Review
docs: don't mark non GTK-Doc as being a GTK-Doc comment block (969 bytes, patch)
2012-11-15 20:07 UTC, Dieter Verfaillie
committed Details | Review
docs: add GTK-Doc generated output to .gitignore (1003 bytes, patch)
2012-11-15 20:08 UTC, Dieter Verfaillie
committed Details | Review

Description Dieter Verfaillie 2012-11-15 19:40:09 UTC
Building g-i reference docs has a few issues, for which patches will be attached shortly...
Comment 1 Dieter Verfaillie 2012-11-15 19:41:35 UTC
Created attachment 229079 [details] [review]
docs: make gtkdoc-mkdb ignore cmph doxygen comment blocks.

When building g-i reference documentation, girepository/cmph/*
was being scanned for GTK-Doc comment blocks by gtkdoc-mkdb.
Unfortunately, cmph uses doxygen comment blocks which also
start with /**. This patch prevents gtkdoc-mkdb from complaining.
Comment 2 Dieter Verfaillie 2012-11-15 19:42:37 UTC
Created attachment 229080 [details] [review]
docs: remove reference to object_grouped.sgml.

This most likely sneaked in as a copy paste error from GTK+
reference docs as g-i never had a object_grouped.sgml...
Comment 3 Dieter Verfaillie 2012-11-15 19:43:33 UTC
Created attachment 229081 [details] [review]
docs: don't mark non GTK-Doc as being a GTK-Doc comment block

This patch silences another gtkdoc-mkdb warning.
Comment 4 Dieter Verfaillie 2012-11-15 19:44:16 UTC
Created attachment 229082 [details] [review]
docs: add GTK-Doc generated output to .gitignore
Comment 5 Dieter Verfaillie 2012-11-15 20:06:19 UTC
Created attachment 229084 [details] [review]
docs: make gtkdoc-mkdb ignore cmph doxygen comment blocks.
Comment 6 Dieter Verfaillie 2012-11-15 20:06:58 UTC
Created attachment 229085 [details] [review]
docs: remove reference to object_grouped.sgml.
Comment 7 Dieter Verfaillie 2012-11-15 20:07:55 UTC
Created attachment 229086 [details] [review]
docs: don't mark non GTK-Doc as being a GTK-Doc comment block
Comment 8 Dieter Verfaillie 2012-11-15 20:08:53 UTC
Created attachment 229087 [details] [review]
docs: add GTK-Doc generated output to .gitignore
Comment 9 Colin Walters 2012-11-15 21:35:13 UTC
Review of attachment 229084 [details] [review]:

Hmm...odd.  They're not listed in the CFILE_GLOB, so I don't know why they'd be picked up, but if this works, that's fine.
Comment 10 Colin Walters 2012-11-15 21:49:50 UTC
Review of attachment 229085 [details] [review]:

Ok.
Comment 11 Colin Walters 2012-11-15 21:50:11 UTC
Review of attachment 229086 [details] [review]:

Yep!
Comment 12 Colin Walters 2012-11-15 21:50:29 UTC
Review of attachment 229087 [details] [review]:

Ok.
Comment 13 Dieter Verfaillie 2012-11-15 22:48:24 UTC
(In reply to comment #9)
> Review of attachment 229084 [details] [review]:
> 
> Hmm...odd.  They're not listed in the CFILE_GLOB, so I don't know why they'd be
> picked up, but if this works, that's fine.

The only use I could find for $(CFILE_GLOB) is as part of the dependencies
for the scan-build.stamp rule in gtk-doc.make. It is not actually used as the
list of sources to scan but it is the list or sources that when changed trigger
a rebuild of the docs. The thing that controls what to scan is $(DOC_SOURCE_DIR)
which is passed to gtkdoc-mkdb which has its own way of determining
what goes in "the list of sources to scan":
http://git.gnome.org/browse/gtk-doc/tree/gtkdoc-mkdb.in#n3666

Anyway, symptoms fixed by the patch are:

make[3]: Entering directory `/home/dieterv/gnome.org/checkout/gobject-introspection/docs/reference'
  DOC   Scanning header files
  DOC   Introspecting gobjects
  DOC   Building XML
../../girepository/gthash.c:53: warning: Symbol name not found at the start of the comment block.
../../girepository/cmph/cmph_structs.h:7: warning: Symbol name not found at the start of the comment block.
../../girepository/cmph/cmph_structs.h:18: warning: Symbol name not found at the start of the comment block.
../../girepository/cmph/bmz8.h:23: warning: Symbol name not found at the start of the comment block.
../../girepository/cmph/bmz8.h:30: warning: Symbol name not found at the start of the comment block.
../../girepository/cmph/bmz8.h:39: warning: Symbol name not found at the start of the comment block.

 and the list went on for a total of 190 warnings...
Comment 14 Dieter Verfaillie 2012-11-15 22:53:55 UTC
Thanks for the review :)
Comment 15 André Klapper 2015-02-07 17:02:09 UTC
[Mass-moving gobject-introspection tickets to its own Bugzilla product - see bug 708029. Mass-filter your bugmail for this message: introspection20150207 ]