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 742501 - macro _VTE_GNUC_NONNULL causing gtk-doc to drop last argument in reference
macro _VTE_GNUC_NONNULL causing gtk-doc to drop last argument in reference
Status: RESOLVED FIXED
Product: vte
Classification: Core
Component: general
0.39.x
Other Linux
: Normal normal
: ---
Assigned To: VTE Maintainers
VTE Maintainers
: 747466 (view as bug list)
Depends on:
Blocks:
 
 
Reported: 2015-01-07 01:35 UTC by Phil Clayton
Modified: 2015-04-08 18:43 UTC
See Also:
GNOME target: ---
GNOME version: ---


Description Phil Clayton 2015-01-07 01:35:56 UTC 
In the VTE function reference, the last argument is missing in the quoted
function signature for most functions - see e.g.
https://developer.gnome.org/vte/0.38/VteTerminal.html
Similarly for the current unstable.

The affected functions are those whose prototype is followed by
_VTE_GNUC_NONNULL(...).  This macro requires
--ignore-decorators='_VTE_GNUC_NONNULL\s*\([^)]*\)'
to be added to SCAN_OPTIONS.  Even then, gtk-doc <= 1.21 will ignore the last argument where this macro does not occur just once.  See
https://bugzilla.gnome.org/show_bug.cgi?id=741941

According to GLib's README.rationale , such a non-null macro should not be used in favour of the introspection annotations.  Therefore, it may make sense to eliminate the macro _VTE_GNUC_NONNULL and its references.
Comment 1 Egmont Koblinger 2015-01-07 18:10:10 UTC 
Thanks for this report!

I submitted a quick fix (which requires a fixed gtk-doc -- bug 741941 comment 5 clearly points out that gtk-doc was buggy so far and just got fixed; I have no desire to work around that bug).

I think we should leave this bug open to replace attributes by annotations if that's indeed superior.
Comment 2 Christian Persch 2015-01-07 18:52:20 UTC 
Annotations are for docs, the attributes are for the compiler. IMO glib is wrong not to add those attributes (see https://bugzilla.gnome.org/show_bug.cgi?id=113075#c46 ), so I'm not going to remove them.
Comment 3 Egmont Koblinger 2015-01-07 19:29:23 UTC 
Changing resolution since the bug is actually fixed. :)
Comment 4 Egmont Koblinger 2015-04-08 18:43:20 UTC 
*** Bug 747466 has been marked as a duplicate of this bug. ***