From afa883bdc680f187d249446f8d20ae9d7f5cdcc6 Mon Sep 17 00:00:00 2001 From: Thomas Anderson Date: Tue, 16 Jun 2009 17:06:15 +0000 Subject: Add information on deprecating eclasses as decided by the Council on May 28, 2009. git-svn-id: svn+ssh://svn.gentoo.org/var/svnroot/devmanual/trunk@150 176d3534-300d-0410-8db8-84e73ed771c3 --- eclass-writing/text.xml | 44 +++++++++++++++++++++++++++++++++++++++----- 1 file changed, 39 insertions(+), 5 deletions(-) (limited to 'eclass-writing') diff --git a/eclass-writing/text.xml b/eclass-writing/text.xml index a9dd85a..36927ac 100644 --- a/eclass-writing/text.xml +++ b/eclass-writing/text.xml @@ -80,11 +80,45 @@ Committing a broken eclass can kill huge numbers of packages. Since A simple way to verify syntax is bash -n foo.eclass.

-

-Eclasses must not be removed from the tree, even if they are no longer used, -as this will cause problems for users who have installed packages which used the -eclass in question. -

+ + + +
+Removing Eclasses + + +

No longer used eclasses may be removed from the tree, but developers must +adhere to the following process(developers must follow these rules because +packages installed with a portage version of less than 2.1.4 would break +during uninstallation or upgrades):

+ +
    +
  1. + Make sure that no packages or other eclasses in the tree inherit the + eclass. +
    2. +
  2. + Send a message to the gentoo-dev and gentoo-dev-announce mailing lists + announcing that the eclass you are deprecating is now deprecated. +
    3. +
  3. + Add a warning to all installation phases that the eclass is now deprecated, + perhaps with a hint at what, if any, eclass replaced the functionality that + the old eclass provided. +
    4. +
  4. + Remove all functionality related to installation of packages from the eclass. +
    5. +
  5. + Add a one line comment saying exactly # @DEAD so that the + eclass-manpages package will not attempt to document it. +
    6. +
  6. + After two years have passed since the eclass was deprecated, the eclass may + be removed from the portage tree. +
    7. +
+
-- cgit v1.2.3-65-gdbad