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 436565 - Report undeclared symbols into a file
Report undeclared symbols into a file
Status: RESOLVED FIXED
Product: gtk-doc
Classification: Platform
Component: general
unspecified
Other Linux
: Normal normal
: 1.9
Assigned To: Sven Herzberg
gtk-doc maintainers
Depends on:
Blocks:
 
 
Reported: 2007-05-07 11:38 UTC by Sven Herzberg
Modified: 2007-09-22 19:51 UTC
See Also:
GNOME target: 2.20.x
GNOME version: ---


Attachments
proposed patch (2.23 KB, patch)
2007-07-17 12:26 UTC, Yeti
committed Details | Review

Description Sven Herzberg 2007-05-07 11:38:25 UTC
When there are undeclared symbols, gtk-doc currently prints a warnings to stdout or stderr. It should also create a file $(DOC_MODULE)-undeclared.txt that developers can read quickly.

I'm looking into this and I just use this bug to document some pieces about the way I'd fix them:
gtkdoc-mktmpl.in:314: shows how such a file can be output
gtkdoc-mkdb.in:637: this is where the warning gets printed
Comment 1 Stefan Sauer (gstreamer, gtkdoc dev) 2007-07-15 16:28:53 UTC
Isn't that the same stuff that ends up in $(DOC_MODULE)-undocumanted.txt ?
Comment 2 Yeti 2007-07-17 12:26:50 UTC
Created attachment 91890 [details] [review]
proposed patch

Implementation.
Comment 3 Stefan Sauer (gstreamer, gtkdoc dev) 2007-07-23 14:26:24 UTC
Ok. $(DOC_MODULE)-undeclared.txt will have the symbols that one put into the $(DOC_MODULE)-sections.txt by where no documentation is found.

The patch looks good too. Will commit later.
Comment 4 Stefan Sauer (gstreamer, gtkdoc dev) 2007-07-23 15:28:25 UTC
2007-07-23  Stefan Kost  <ensonic@users.sf.net>

	Patch by: Yeti <yeti@physics.muni.cz>

	* gtk-doc.make:
	* gtkdoc-mkdb.in:
	  Report undeclared symbols into a file. Fixes #436565.