From 131d0b840bf30d89c2f8031e8d51f72abf543e9f Mon Sep 17 00:00:00 2001 From: Otto Liljalaakso Date: Apr 19 2024 11:18:14 +0000 Subject: Consider obsoleting in main retirement steps Previously, consideration for obsoleting the newly retired package was only given almost at the end of the Package Retirement Process page, having both EPEL considerations and unretirement instructions before that section. Make it more obvious that obsoleting should be considered every time a package is retired, by changing that to a step within the main retirement steps. Also, move the reference to the related, but different process of renaming or replacing a package to the first, general section, rather than hiding it within the obsoleting considerations. This change was motivated by this mailing list thread: https://lists.fedoraproject.org/archives/list/devel@lists.fedoraproject.org/message/OOFDTAWZE2H7INXNQLW7VIONBKHNAUVZ/ --- diff --git a/modules/ROOT/pages/Package_Retirement_Process.adoc b/modules/ROOT/pages/Package_Retirement_Process.adoc index 68fc5be..a34efd3 100644 --- a/modules/ROOT/pages/Package_Retirement_Process.adoc +++ b/modules/ROOT/pages/Package_Retirement_Process.adoc @@ -9,6 +9,11 @@ know both not to expect any more releases, and why it was removed. The process is governed by xref:fesco::Policy_for_orphan_and_retired_packages.adoc[Policy for Orphan and Retired Packages]. +A common situation that involves, among other tasks, retiring a package is +renaming a package, or replacing it with another that provides compatible functionality. +For handing such situation, see +xref:packaging-guidelines::index.adoc#renaming-or-replacing-existing-packages[the relevant packaging guidelines]. + [#what_can_be_retired] == What can be retired == @@ -50,6 +55,15 @@ Packages must not be retired from stable releases. If the package is included in EPEL, consider also xref:epel::epel-policy-retirement.adoc[EPEL Retirement policy]. +[#obsoleting_packages] +=== fedora-obsolete-packages + +Consider what will happen to systems which have the now-retired packages installed. +Generally, such packages will simply remain on the system as it is updated, +becoming increasingly outdated. +If this is not acceptable, such as if there are upgrade path issues or security concerns, +add your package to https://src.fedoraproject.org/rpms/fedora-obsolete-packages/[fedora-obsolete-packages]. + === Comps Remove the package from https://fedoraproject.org/wiki/How_to_use_and_edit_comps.xml_for_package_groups[comps] if it is listed. @@ -150,24 +164,6 @@ clearly specify which branches should be unblocked. . Restore the contents in Git and prepare a new build and update (if necessary). -[#obsoleting_packages] -== Obsoleting Packages - -While not strictly part of the process, -please consider what will happen -to systems which have the now-retired packages installed. -Generally, such packages will simply remain on the system as it is updated, -becoming increasingly outdated. - -Please consider adding your package to https://src.fedoraproject.org/rpms/fedora-obsolete-packages/[fedora-obsolete-packages] -if there are upgrade path issues or security concerns. - -Please follow xref:packaging-guidelines::index.adoc#renaming-or-replacing-existing-packages[the relevant packaging guidelines] -if another package will be providing -similar or identical functionality to the retired package, -or if it is necessary that the package be removed from end-user systems -on system updates. - [#complete_removal] == Completely Removing a Package