[PATCH] fdo-mime.eclass: Mark the eclass as deprecated

classic Classic list List threaded Threaded
4 messages Options
Reply | Threaded
Open this post in threaded view
|

[PATCH] fdo-mime.eclass: Mark the eclass as deprecated

Michał Górny-5
The GNOME team has committed the xdg-utils.eclass serving exactly
the same purpose as fdo-mime.eclass, supposedly with the goal of
replacing it. However, it seems that they have never bothered to
actually hint the deprecation in the fdo-mime.eclass in any way.
As a result, developers are still adding references to this eclass
instead of using xdg-utils or xdg, and/or not working towards replacing
them.

Add an explicit deprecation notice to the fdo-mime.eclass to make it
clear that the eclass should not be used in new packages, and what
the replacement eclasses are.
---
 eclass/fdo-mime.eclass | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/eclass/fdo-mime.eclass b/eclass/fdo-mime.eclass
index b3b096d154e7..8e51d8a69df1 100644
--- a/eclass/fdo-mime.eclass
+++ b/eclass/fdo-mime.eclass
@@ -1,4 +1,4 @@
-# Copyright 1999-2011 Gentoo Foundation
+# Copyright 1999-2017 Gentoo Foundation
 # Distributed under the terms of the GNU General Public License v2
 
 # @ECLASS: fdo-mime.eclass
@@ -7,6 +7,8 @@
 # @AUTHOR:
 # Original author: foser <[hidden email]>
 # @BLURB: Utility eclass to update the desktop mime info as laid out in the freedesktop specs & implementations
+# @DESCRIPTION:
+# This eclass is DEPRECATED. Please use xdg-utils or xdg instead.
 
 # @FUNCTION: fdo-mime_desktop_database_update
 # @DESCRIPTION:
--
2.13.1


Reply | Threaded
Open this post in threaded view
|

Re: [PATCH] fdo-mime.eclass: Mark the eclass as deprecated

Daniel Campbell (zlg)
On 06/19/2017 06:20 AM, Michał Górny wrote:

> The GNOME team has committed the xdg-utils.eclass serving exactly
> the same purpose as fdo-mime.eclass, supposedly with the goal of
> replacing it. However, it seems that they have never bothered to
> actually hint the deprecation in the fdo-mime.eclass in any way.
> As a result, developers are still adding references to this eclass
> instead of using xdg-utils or xdg, and/or not working towards replacing
> them.
>
> Add an explicit deprecation notice to the fdo-mime.eclass to make it
> clear that the eclass should not be used in new packages, and what
> the replacement eclasses are.
> ---
>  eclass/fdo-mime.eclass | 4 +++-
>  1 file changed, 3 insertions(+), 1 deletion(-)
>
> diff --git a/eclass/fdo-mime.eclass b/eclass/fdo-mime.eclass
> index b3b096d154e7..8e51d8a69df1 100644
> --- a/eclass/fdo-mime.eclass
> +++ b/eclass/fdo-mime.eclass
> @@ -1,4 +1,4 @@
> -# Copyright 1999-2011 Gentoo Foundation
> +# Copyright 1999-2017 Gentoo Foundation
>  # Distributed under the terms of the GNU General Public License v2
>  
>  # @ECLASS: fdo-mime.eclass
> @@ -7,6 +7,8 @@
>  # @AUTHOR:
>  # Original author: foser <[hidden email]>
>  # @BLURB: Utility eclass to update the desktop mime info as laid out in the freedesktop specs & implementations
> +# @DESCRIPTION:
> +# This eclass is DEPRECATED. Please use xdg-utils or xdg instead.
>  
>  # @FUNCTION: fdo-mime_desktop_database_update
>  # @DESCRIPTION:
>
Looks good to me. Thanks for looking out for stuff like this.

That aside, isn't this supposed to be standard operating procedure if a
developer is deprecating an eclass? And similarly with the removal of an
eclass, all ebuilds getting updated by the developer or team that
prompted the removal of the eclass?

My apologies if this is answered elsewhere. I want to be sure what's
expected, just in case I need to touch an eclass.

--
Daniel Campbell - Gentoo Developer
OpenPGP Key: 0x1EA055D6 @ hkp://keys.gnupg.net
fpr: AE03 9064 AE00 053C 270C  1DE4 6F7A 9091 1EA0 55D6


signature.asc (849 bytes) Download Attachment
Reply | Threaded
Open this post in threaded view
|

Re: [PATCH] fdo-mime.eclass: Mark the eclass as deprecated

Jonas Stein
In reply to this post by Michał Górny-5
On 19/06/17 15:20, Michał Górny wrote:

> The GNOME team has committed the xdg-utils.eclass serving exactly
> the same purpose as fdo-mime.eclass, supposedly with the goal of
> replacing it. However, it seems that they have never bothered to
> actually hint the deprecation in the fdo-mime.eclass in any way.
> As a result, developers are still adding references to this eclass
> instead of using xdg-utils or xdg, and/or not working towards replacing
> them.
>
> Add an explicit deprecation notice to the fdo-mime.eclass to make it
> clear that the eclass should not be used in new packages, and what
> the replacement eclasses are.
Packages and Ebuilds which are still using the fdo-mime are listed here:

Packages:
https://qa-reports.gentoo.org/output/eclass-usage/fdo-mime.txt

Ebuilds sorted by Maintainer or Package
http://gentoo.levelnine.at/simplechecks/fdo-mime-check/

If you see your name in the list, you find a list of your packages with
inherit fdo-mime.

Thanks to Michael. For his script.

--
Best,
Jonas


signature.asc (1000 bytes) Download Attachment
Reply | Threaded
Open this post in threaded view
|

Re: [PATCH] fdo-mime.eclass: Mark the eclass as deprecated

Daniel Campbell (zlg)
On Mon, Nov 13, 2017 at 03:30:11AM +0100, Jonas Stein wrote:

> On 19/06/17 15:20, Michał Górny wrote:
> > The GNOME team has committed the xdg-utils.eclass serving exactly
> > the same purpose as fdo-mime.eclass, supposedly with the goal of
> > replacing it. However, it seems that they have never bothered to
> > actually hint the deprecation in the fdo-mime.eclass in any way.
> > As a result, developers are still adding references to this eclass
> > instead of using xdg-utils or xdg, and/or not working towards replacing
> > them.
> >
> > Add an explicit deprecation notice to the fdo-mime.eclass to make it
> > clear that the eclass should not be used in new packages, and what
> > the replacement eclasses are.
>
> Packages and Ebuilds which are still using the fdo-mime are listed here:
>
> Packages:
> https://qa-reports.gentoo.org/output/eclass-usage/fdo-mime.txt
>
> Ebuilds sorted by Maintainer or Package
> http://gentoo.levelnine.at/simplechecks/fdo-mime-check/
>
> If you see your name in the list, you find a list of your packages with
> inherit fdo-mime.
>
> Thanks to Michael. For his script.
>
> --
> Best,
> Jonas
>
Great tool! Super easy for maintainers to check their packages. I have
fixes ready for x11-misc/spacefm, but I could not find a bug number to
reference. Are we tracking this on bugzy or just pushing everyone to go
ahead and update their ebuilds? I searched bugzy for 'fdo-mime' and the
only relevant bug is 621914 [1], which I assume was the original discussion
to get us onto xdg-utils since it's newer.

If there's no tracker bug I need to reference, that's fine. Just wanted
to be sure I'm not missing anything before pushing.

[1]: https://bugs.gentoo.org/621914

--
Daniel Campbell - Gentoo Developer, Trustee, Treasurer
OpenPGP Key: 0x1EA055D6 @ hkp://keys.gnupg.net
fpr: AE03 9064 AE00 053C 270C  1DE4 6F7A 9091 1EA0 55D6

signature.asc (849 bytes) Download Attachment