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 730658 - Deprecation warning for non-deprecated type GParamFlags
Deprecation warning for non-deprecated type GParamFlags
Status: RESOLVED FIXED
Product: gtk-doc
Classification: Platform
Component: general
unspecified
Other Linux
: Normal normal
: 1.21
Assigned To: gtk-doc maintainers
gtk-doc maintainers
Depends on:
Blocks:
 
 
Reported: 2014-05-23 19:00 UTC by Volker Sobek (weld)
Modified: 2014-07-09 13:42 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
tests: Add an enumeration value with DEPRECATED in its name (1.39 KB, patch)
2014-06-27 12:20 UTC, Emmanuele Bassi (:ebassi)
committed Details | Review
scan: Ignore enumeration fields with DEPRECATED in their name (1.08 KB, patch)
2014-06-27 12:20 UTC, Emmanuele Bassi (:ebassi)
committed Details | Review
scan: Ignore enumeration fields with DEPRECATED in their name (1.10 KB, patch)
2014-07-09 13:42 UTC, Stefan Sauer (gstreamer, gtkdoc dev)
committed Details | Review
tests: Add an enumeration value with DEPRECATED in its name (1.40 KB, patch)
2014-07-09 13:42 UTC, Stefan Sauer (gstreamer, gtkdoc dev)
committed Details | Review

Description Volker Sobek (weld) 2014-05-23 19:00:55 UTC
Currently the generated docs for gobject show a deprecation warning for GParamFlags, even though they are not deprecated (also for /unstable/):
https://developer.gnome.org/gobject/stable/gobject-GParamSpec.html#GParamFlags
Comment 1 Volker Sobek (weld) 2014-05-23 19:02:10 UTC
mclasen just figured out more:
<mclasen> it indeed gets confused by G_PARAM_DEPRECATED
<mclasen> take that out and it doesn't think it is deprecated anymore
Comment 2 Volker Sobek (weld) 2014-05-23 19:30:58 UTC
After greping a bit, I suspect (didn't test) this part of gtkdoc-scan catches G_PARAM_DEPRECATED and misinterprets it:

        # If we find a line containing _DEPRECATED, we hope that this is
        # attribute based deprecation and also treat this as a deprecation
        # guard.
        if ($deprecated_conditional_nest == 0 and m/_DEPRECATED/) {
            $deprecated_conditional_nest += 0.1;
        }
Comment 3 Emmanuele Bassi (:ebassi) 2014-06-27 12:08:39 UTC
see also: https://bugzilla.gnome.org/show_bug.cgi?id=731417
Comment 4 Emmanuele Bassi (:ebassi) 2014-06-27 12:20:17 UTC
Created attachment 279389 [details] [review]
tests: Add an enumeration value with DEPRECATED in its name

This should not mean that the enumeration is deprecated.
Comment 5 Emmanuele Bassi (:ebassi) 2014-06-27 12:20:28 UTC
Created attachment 279390 [details] [review]
scan: Ignore enumeration fields with DEPRECATED in their name

GParamFlags should not be declared deprecated just because it has a
value called G_PARAM_DEPRECATED.
Comment 6 Emmanuele Bassi (:ebassi) 2014-06-27 12:24:04 UTC
the two patches above rely on the two patches for bug 731417, which solve a similar problem for macros.
Comment 7 Stefan Sauer (gstreamer, gtkdoc dev) 2014-07-09 13:42:04 UTC
The following fixes have been pushed:
776edf4 scan: Ignore enumeration fields with DEPRECATED in their name
f5daece tests: Add an enumeration value with DEPRECATED in its name
Comment 8 Stefan Sauer (gstreamer, gtkdoc dev) 2014-07-09 13:42:15 UTC
Created attachment 280270 [details] [review]
scan: Ignore enumeration fields with DEPRECATED in their name

GParamFlags should not be declared deprecated just because it has a
value called G_PARAM_DEPRECATED.
Comment 9 Stefan Sauer (gstreamer, gtkdoc dev) 2014-07-09 13:42:20 UTC
Created attachment 280271 [details] [review]
tests: Add an enumeration value with DEPRECATED in its name

This should not mean that the enumeration is deprecated.