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 794590 - Do not warn about deprecated symbols without guards in case of macros
Do not warn about deprecated symbols without guards in case of macros
Status: RESOLVED NOTABUG
Product: gtk-doc
Classification: Platform
Component: general
unspecified
Other Linux
: Normal normal
: ---
Assigned To: gtk-doc maintainers
gtk-doc maintainers
Depends on:
Blocks:
 
 
Reported: 2018-03-22 09:21 UTC by Carlos Garcia Campos
Modified: 2018-03-26 07:34 UTC
See Also:
GNOME target: ---
GNOME version: ---

Attachments
mkdb: do not warn about deprecated symbols without guards in case of macros (1.15 KB, patch)
2018-03-22 09:22 UTC, Carlos Garcia Campos 		none Details | Review

Description Carlos Garcia Campos 2018-03-22 09:21:14 UTC 
We already handle the case of properties and signals, but macros don't have a guard either.

warning: WEBKIT_DOM_XPATH_RESULT_FIRST_ORDERED_NODE_TYPE is deprecated in the inline comments, but no deprecation guards were found around the declaration. (See the --deprecated-guards option for gtkdoc-scan.)

Got a bunch of this after deprecating several public macros in WebKit DOM API.
Comment 1 Carlos Garcia Campos 2018-03-22 09:22:19 UTC 
Created attachment 369996 [details] [review]
mkdb: do not warn about deprecated symbols without guards in case of macros
Comment 2 Stefan Sauer (gstreamer, gtkdoc dev) 2018-03-23 21:22:00 UTC 
Why can't macros have deprecation guards?
Comment 3 Carlos Garcia Campos 2018-03-24 10:12:24 UTC 
I think they can only be used with functions.
Comment 4 Stefan Sauer (gstreamer, gtkdoc dev) 2018-03-24 15:42:11 UTC 
I mean all the the deprecation guards do is:

#ifndef FOOBAR_DISABLE_DEPRECATED
#define WEBKIT_DOM_XPATH_RESULT_FIRST_ORDERED_NODE_TYPE
#endif
Comment 5 Carlos Garcia Campos 2018-03-26 06:30:53 UTC 
(In reply to Stefan Sauer (gstreamer, gtkdoc dev) from comment #4)
> I mean all the the deprecation guards do is:
> 
> #ifndef FOOBAR_DISABLE_DEPRECATED
> #define WEBKIT_DOM_XPATH_RESULT_FIRST_ORDERED_NODE_TYPE
> #endif

Ah, I thought the warning was about missing G_DEPRECATED.
Comment 6 Carlos Garcia Campos 2018-03-26 07:34:42 UTC 
You are right, those guards fixed the issue, thanks. Sorry for the noise.