From 5ea289117d9334db43d1c3db378a41aac3aad9da Mon Sep 17 00:00:00 2001 From: Miro Hrončok Date: Apr 21 2020 07:48:18 +0000 Subject: Fix syntax of Deprecating Packages --- diff --git a/guidelines/modules/ROOT/pages/deprecating-packages.adoc b/guidelines/modules/ROOT/pages/deprecating-packages.adoc index 3af99c3..b318681 100644 --- a/guidelines/modules/ROOT/pages/deprecating-packages.adoc +++ b/guidelines/modules/ROOT/pages/deprecating-packages.adoc @@ -13,33 +13,41 @@ If a package is a dependency of other packages in the distribution (which are no In order to mark a package deprecated, a special virtual provides is added: -`+ Provides: deprecated()+` +.... +Provides: deprecated() +.... If the package has subpackages and the packager intends to deprecate the package as a whole, packager MUST mark all subpackages as being deprecated. -`+Name:      mainpackage+` + -`+...+` + -`+Provides:  deprecated()+` + - + -`+...+` + - + -`+%package subpackage+` + -`+...+` + -`+Provides:  deprecated()+` +.... +Name:      mainpackage +... +Provides:  deprecated() + +... + +%package subpackage +... +Provides:  deprecated() +.... Alternatively, a packager MAY decide to only deprecate some subpackages. A packager SHOULD add a comment in the spec explaining why a package is being deprecated. For example: -`+# net-tools (ifconfig etc.) have been obsoleted for ~20 years upstream.+` + -`+# We want to get rid of it from Fedora in favor of the iproute package,+` + -`+# however many sysadmins still expect ifconfig to be there, so we keep it+` + -`+# around as a deprecated package.+` + -`+Provides:  deprecated()+` +.... +# net-tools (ifconfig etc.) have been obsoleted for ~20 years upstream. +# We want to get rid of it from Fedora in favor of the iproute package, +# however many sysadmins still expect ifconfig to be there, so we keep it +# around as a deprecated package. +Provides:  deprecated() +.... If a date for the final removal of the package from the distribution is known, it MAY be included as follows: -`+Provides:  deprecated() == YYYYMMDD+` +.... +Provides:  deprecated() == YYYYMMDD +.... The special `+deprecated()+` provide MUST NOT be added in any released branch of Fedora. It is acceptable to deprecate packages in rawhide (the master branch), the branch for an upcoming Fedora release (if one exists) up until the time of the https://fedoraproject.org/wiki/Schedule[Final Freeze], and to EPEL branches (at any time). Also note that because packages may exist in a deprecated state for some time, those packages can eventually enter release branches. The restriction is on the initial addition of the `+deprecated()+` tag.