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 735416 - macros2: Remove GNOME_COMMON_INIT
macros2: Remove GNOME_COMMON_INIT
Status: RESOLVED FIXED
Product: gnome-common
Classification: Core
Component: general
git master
Other Linux
: Normal normal
: ---
Assigned To: Gnome Common Maintainer(s)
Gnome Common Maintainer(s)
Depends on:
Blocks:
 
 
Reported: 2014-08-25 23:13 UTC by Philip Withnall
Modified: 2016-05-13 15:27 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
macros2: Remove GNOME_COMMON_INIT (1.47 KB, patch)
2014-08-25 23:14 UTC, Philip Withnall
committed Details | Review

Description Philip Withnall 2014-08-25 23:13:39 UTC
Patch coming. I can't find any uses of it in my checked out modules, and it's been deprecated for a while.
Comment 1 Philip Withnall 2014-08-25 23:14:01 UTC
Created attachment 284458 [details] [review]
macros2: Remove GNOME_COMMON_INIT

It’s been deprecated for a while, and apparently no modules (which I
have checked out, at least) still use it.
Comment 2 David King 2014-08-26 06:47:51 UTC
Review of attachment 284458 [details] [review]:

Seems fine, but this should probably not be pushed until after the freeze (as I guess this counts as an API change, even though it is unlikely that anything is calling GNOME_COMMON_INIT any more).
Comment 3 Philip Withnall 2014-08-26 07:55:57 UTC
(In reply to comment #2)
> Review of attachment 284458 [details] [review]:
> 
> Seems fine, but this should probably not be pushed until after the freeze (as I
> guess this counts as an API change, even though it is unlikely that anything is
> calling GNOME_COMMON_INIT any more).

Yeah, sorry, I meant to catch you on IRC to mention that I thought an ideal time to try and get all these changes in would be the start of the next cycle…but I forgot. :-(
Comment 4 David King 2014-08-26 08:03:06 UTC
(In reply to comment #3)
> Yeah, sorry, I meant to catch you on IRC to mention that I thought an ideal
> time to try and get all these changes in would be the start of the next
> cycle…but I forgot. :-(

Not a problem. I was away from IRC all day yesterday (bliss!), so it would have been difficult to find me anyway. :-)
Comment 5 Philip Withnall 2014-09-23 07:13:24 UTC
Pushed.

Attachment 284458 [details] pushed as 6684e2f - macros2: Remove GNOME_COMMON_INIT
Comment 6 Michael Biebl 2015-10-09 22:47:45 UTC
FYI: http://codesearch.debian.net/results/GNOME_COMMON_INIT/page_0

Looks like quite a few 3rd party packages still use that macro
Comment 7 Philip Withnall 2015-10-13 14:47:48 UTC
(In reply to Michael Biebl from comment #6)
> FYI: http://codesearch.debian.net/results/GNOME_COMMON_INIT/page_0
> 
> Looks like quite a few 3rd party packages still use that macro

I guess they should depend on an older version of gnome-common then. Anything before 3.18.0 should do.
Comment 8 Michael Biebl 2016-05-13 13:37:00 UTC
Depending on an older version is not really possible (within) Debian as we can only ship a single version of gnome-common. It means we would have to package gnome-common <= 3.14 as a separate package like say gnome-common-legacy.

I'm counting 44 packages in Debian using GNOME_COMMON_INIT and 54 using GNOME_DOC_INIT.

Are there migration guides somewhere what packages should do if they want to get rid of those macros?
Comment 9 David King 2016-05-13 14:36:54 UTC
(In reply to Michael Biebl from comment #8)
> Are there migration guides somewhere what packages should do if they want to
> get rid of those macros?

GNOME_DOC_INIT should be replaced by use of yelp.m4 (YELP_HELP_INIT), and GNOME_COMMON_INIT should simply be removed.
Comment 10 Michael Biebl 2016-05-13 14:47:58 UTC
(In reply to David King from comment #9)
> (In reply to Michael Biebl from comment #8)
> > Are there migration guides somewhere what packages should do if they want to
> > get rid of those macros?
> 
> GNOME_DOC_INIT should be replaced by use of yelp.m4 (YELP_HELP_INIT), and
> GNOME_COMMON_INIT should simply be removed.

Regarding GNOME_DOC_INIT and YELP_INIT: Is this really that simple or do the docs itself need adjustments for yelp? I.e., is YELP_INIT a drop-in replacement for GNOME_DOC_INIT?
Comment 11 Philip Withnall 2016-05-13 14:55:34 UTC
See also, https://wiki.gnome.org/Projects/GnomeCommon/Migration.
Comment 12 David King 2016-05-13 14:56:22 UTC
YELP_INIT can be used a drop-in relacement for GNOME_DOC_INIT (it even works fine for DocBook XML).
Comment 13 Michael Biebl 2016-05-13 15:26:00 UTC
Thanks Philip and David. Would be great if you can add the info about GNOME_DOC_INIT/YELP_INIT also to the wiki.
This makes it easier to point users/developers at a single place containing all information.
Comment 14 Michael Biebl 2016-05-13 15:27:47 UTC
And GNOME_COMMON_INIT isn't listed on the wiki either. A short section that this macro can be removed safely, would be helpful.