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 740875 - gtk-doc.make should have a "make check" rule failing if there are undocumented symbols
gtk-doc.make should have a "make check" rule failing if there are undocumente...
Status: RESOLVED INVALID
Product: gtk-doc
Classification: Platform
Component: general
unspecified
Other Linux
: Normal normal
: ---
Assigned To: gtk-doc maintainers
gtk-doc maintainers
Depends on:
Blocks:
 
 
Reported: 2014-11-28 20:55 UTC by Xavier Claessens
Modified: 2014-12-12 15:12 UTC
See Also:
GNOME target: ---
GNOME version: ---

Attachments
gtk-doc.make: Add ENABLE_GTK_DOC_CHECK option (1.82 KB, patch)
2014-11-28 20:56 UTC, Xavier Claessens 		none Details | Review
gtk-doc.make: Add ENABLE_GTK_DOC_CHECK option (2.40 KB, patch)
2014-12-08 18:14 UTC, Xavier Claessens 		none Details | Review
gtk-doc.make: Add ENABLE_GTK_DOC_CHECK option (3.79 KB, patch)
2014-12-08 19:27 UTC, Xavier Claessens 		none Details | Review

Description Xavier Claessens 2014-11-28 20:55:26 UTC 
It should be easy for projects to assert that they have 100% documentation coverage. telepathy-glib does it and I'm working on doing in glib/gobject/gio in bug #740814
Comment 1 Xavier Claessens 2014-11-28 20:56:05 UTC 
Created attachment 291754 [details] [review]
gtk-doc.make: Add ENABLE_GTK_DOC_CHECK option

When enabled, "make check" will fail if some symbols are
unused/undocumented/undeclared.

Based on code from telepathy-glib, written by
Simon McVittie <simon.mcvittie@collabora.co.uk>
Comment 2 Xavier Claessens 2014-12-02 20:10:34 UTC 
Hm, that patch would break all projects that does not add an AM_CONDITIONAL(ENABLE_GTK_DOC_CHECK, []) in their configure.ac

I don't know how this can be made conditional, the idea is that in glib we want to enable it only on linux. Any autotools guru who can help?
Comment 3 Xavier Claessens 2014-12-08 18:14:28 UTC 
Created attachment 292313 [details] [review]
gtk-doc.make: Add ENABLE_GTK_DOC_CHECK option

When enabled, "make check" will fail if some symbols are
unused/undocumented/undeclared.

Based on code from telepathy-glib, written by
Simon McVittie <simon.mcvittie@collabora.co.uk>
Comment 4 Xavier Claessens 2014-12-08 18:16:06 UTC 
Like that, it seems to work, projects can redefine ENABLE_GTK_DOC_CHECK after the call to GTK_DOC_CHECK in their configure.ac.
Comment 5 Xavier Claessens 2014-12-08 19:27:13 UTC 
Created attachment 292320 [details] [review]
gtk-doc.make: Add ENABLE_GTK_DOC_CHECK option

When enabled, "make check" will fail if some symbols are
unused/undocumented/undeclared.

Based on code from telepathy-glib, written by
Simon McVittie <simon.mcvittie@collabora.co.uk>
Comment 6 Stefan Sauer (gstreamer, gtkdoc dev) 2014-12-12 08:53:45 UTC 
Can't use use gtkdoc-check? See
https://git.gnome.org/browse/gtk-doc/tree/examples/Makefile.am#n96
Comment 7 Xavier Claessens 2014-12-12 15:12:21 UTC 
Yep, that seems to be exactly that, thanks !