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 627973 - introspection: Split off private sources
introspection: Split off private sources
Status: RESOLVED FIXED
Product: pango
Classification: Platform
Component: general
unspecified
Other All
: Normal normal
: ---
Assigned To: pango-maint
pango-maint
Depends on:
Blocks:
 
 
Reported: 2010-08-25 18:27 UTC by Colin Walters
Modified: 2012-04-18 15:31 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
introspection: Split off private sources (3.35 KB, patch)
2010-08-25 18:27 UTC, Colin Walters
none Details | Review
introspection: Filter out private headers (2.78 KB, patch)
2010-08-31 22:13 UTC, Colin Walters
committed Details | Review

Description Colin Walters 2010-08-25 18:27:29 UTC
SImilarly to how gtk-doc requires IGNORE_HFILES, split off
the "private" sources which we don't want to scan into separate
makefile variables.
Comment 1 Colin Walters 2010-08-25 18:27:31 UTC
Created attachment 168755 [details] [review]
introspection: Split off private sources
Comment 2 Behdad Esfahbod 2010-08-25 18:52:51 UTC
Maybe you should define what you mean by public/private source then?!  I understand that concept for header files.  And indeed, public headers are separate already.
Comment 3 Colin Walters 2010-08-25 19:16:30 UTC
The headers weren't entirely separate actually.  An example problematic header file is pango-script-private.h, which references ParenStackEntry, which is an internal non-namespaced structure.

The new scanner will complain when seeing such structures, rather than simply assume it's public API.

The patch arguably could have just removed the -private.h from the public sources, but it seems cleaner to also segregate off the private C files.
Comment 4 Behdad Esfahbod 2010-08-25 19:24:38 UTC
You still refer to "public sources" without defining that term.  I don't know what that means.  Headers included in the _SOURCES variables are not automatically public.  Public headers are those and only those that are installed.
Comment 5 Colin Walters 2010-08-25 19:30:26 UTC
public source: Source files contain the gtk-doc for functions implementing public API.
Comment 6 Colin Walters 2010-08-31 21:38:52 UTC
So...what do you want to see here?
Comment 7 Colin Walters 2010-08-31 22:13:55 UTC
Created attachment 169198 [details] [review]
introspection: Filter out private headers

We shouldn't scan private headers.  Also add --warn-all.
Comment 8 Colin Walters 2010-08-31 22:14:13 UTC
Alternative approach attached.
Comment 9 Javier Jardón (IRC: jjardon) 2012-04-18 15:31:44 UTC
Comment on attachment 169198 [details] [review]
introspection: Filter out private headers

This was committed in 0aa7efebfbbe72336f5db23279ef1c93ab839b17