GNOME Bugzilla – Bug 688418
Building g-i reference docs has a few issues
Last modified: 2015-02-07 17:02:09 UTC
Building g-i reference docs has a few issues, for which patches will be attached shortly...
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.
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...
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.
Created attachment 229082 [details] [review] docs: add GTK-Doc generated output to .gitignore
Created attachment 229084 [details] [review] docs: make gtkdoc-mkdb ignore cmph doxygen comment blocks.
Created attachment 229085 [details] [review] docs: remove reference to object_grouped.sgml.
Created attachment 229086 [details] [review] docs: don't mark non GTK-Doc as being a GTK-Doc comment block
Created attachment 229087 [details] [review] docs: add GTK-Doc generated output to .gitignore
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.
Review of attachment 229085 [details] [review]: Ok.
Review of attachment 229086 [details] [review]: Yep!
Review of attachment 229087 [details] [review]: Ok.
(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...
Thanks for the review :)
[Mass-moving gobject-introspection tickets to its own Bugzilla product - see bug 708029. Mass-filter your bugmail for this message: introspection20150207 ]