commit: 4e0dc9321c17dda46d81bebce8c757b35dfb29e9 Author: Ulrich Müller <ulm <AT> gentoo <DOT> org> AuthorDate: Tue Jan 21 10:52:47 2020 +0000 Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org> CommitDate: Thu Jan 23 07:48:06 2020 +0000 URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=4e0dc932
ebuild-maintenance/removal: New chapter. Split off from ebuild-maintenance/maintenance-tasks. Signed-off-by: Ulrich Müller <ulm <AT> gentoo.org> ebuild-maintenance/maintenance-tasks/text.xml | 83 ------------------------- ebuild-maintenance/removal/text.xml | 89 +++++++++++++++++++++++++++ ebuild-maintenance/text.xml | 1 + 3 files changed, 90 insertions(+), 83 deletions(-) diff --git a/ebuild-maintenance/maintenance-tasks/text.xml b/ebuild-maintenance/maintenance-tasks/text.xml index f4e421a..8a2c3fc 100644 --- a/ebuild-maintenance/maintenance-tasks/text.xml +++ b/ebuild-maintenance/maintenance-tasks/text.xml @@ -11,89 +11,6 @@ developers may not be familiar with. </p> </body> -<section> -<title>Removing ebuilds</title> -<body> - -<p> -When removing an ebuild make sure that no dependencies in Portage are broken -due to the removal <d/> additionally, your git commit message should explain -clearly why the ebuild is being removed from the git repository. -</p> - -<p> -If you need to remove ebuilds, make sure you do not accidentally remove -the newest/only stable ebuild for any architecture. If you would like to -get a newer version marked stable, then please file a bug or ask on IRC. -</p> - -<p> -You should also not cause an unnecessary downgrade for any "<c>~arch</c>" -when removing ebuilds <d/> instead, it is best to get the newest version -marked "<c>~arch</c>" first and then remove redundant versions of the ebuild. -</p> - -</body> -</section> - -<section> -<title>Removing a package</title> -<body> - -<p> -When removing packages follow these steps: -</p> - -<ol> - <li> - Make sure that no dependencies in the Gentoo repository are broken due to - the removal - </li> - <li>Send last rites to gentoo-dev-announce and gentoo-dev</li> - <li>Mask the package</li> - <li>Wait 30 days (or more)</li> - <li>Remove from the git tree unless the reason for removal has been fixed</li> - <li> - Remove any references to the package from other ebuilds, e.g., - use-conditional dependencies. Blockers are the only exception to this. - </li> - <li>Remove package.mask and any package.use.mask entries</li> - <li> - Remove the <c><pkg></c> tags referencing this package in the - <uri link="::ebuild-writing/misc-files/metadata">metadata.xml</uri> - files of other packages. - </li> - <li>Close open bugs as WONTFIX</li> -</ol> - -<p> -Here is a list of commands that will delete <c>dev-util/pmk</c> -from the tree: -</p> - -<pre> -# cd dev-qt -# git rm -rf qtphonon -# git commit --gpg-sign -</pre> - -<p> -An example commit message is shown below: -</p> - -<pre> -commit b97eb6d43f45dfd5b739638928db22d3f3392685 -Author: Michael Palimaka <kensing...@gentoo.org> -Date: Tue Oct 3 21:43:03 2017 +1100 - - dev-qt/qtphonon: remove last rited package - - Closes: https://bugs.gentoo.org/629144 -</pre> - -</body> -</section> - <section> <title>Conflicting files</title> <body> diff --git a/ebuild-maintenance/removal/text.xml b/ebuild-maintenance/removal/text.xml new file mode 100644 index 0000000..6269e13 --- /dev/null +++ b/ebuild-maintenance/removal/text.xml @@ -0,0 +1,89 @@ +<?xml version="1.0"?> +<guide self="ebuild-maintenance/removal/"> +<chapter> +<title>Removing Ebuilds and Packages</title> + +<section> +<title>Removing ebuilds</title> +<body> + +<p> +When removing an ebuild make sure that no dependencies in Portage are broken +due to the removal <d/> additionally, your git commit message should explain +clearly why the ebuild is being removed from the git repository. +</p> + +<p> +If you need to remove ebuilds, make sure you do not accidentally remove +the newest/only stable ebuild for any architecture. If you would like to +get a newer version marked stable, then please file a bug or ask on IRC. +</p> + +<p> +You should also not cause an unnecessary downgrade for any "<c>~arch</c>" +when removing ebuilds <d/> instead, it is best to get the newest version +marked "<c>~arch</c>" first and then remove redundant versions of the ebuild. +</p> + +</body> +</section> + +<section> +<title>Removing a package</title> +<body> + +<p> +When removing packages follow these steps: +</p> + +<ol> + <li> + Make sure that no dependencies in the Gentoo repository are broken due to + the removal + </li> + <li>Send last rites to gentoo-dev-announce and gentoo-dev</li> + <li>Mask the package</li> + <li>Wait 30 days (or more)</li> + <li>Remove from the git tree unless the reason for removal has been fixed</li> + <li> + Remove any references to the package from other ebuilds, e.g., + use-conditional dependencies. Blockers are the only exception to this. + </li> + <li>Remove package.mask and any package.use.mask entries</li> + <li> + Remove the <c><pkg></c> tags referencing this package in the + <uri link="::ebuild-writing/misc-files/metadata">metadata.xml</uri> + files of other packages. + </li> + <li>Close open bugs as WONTFIX</li> +</ol> + +<p> +Here is a list of commands that will delete <c>dev-util/pmk</c> +from the tree: +</p> + +<pre> +# cd dev-qt +# git rm -rf qtphonon +# git commit --gpg-sign +</pre> + +<p> +An example commit message is shown below: +</p> + +<pre> +commit b97eb6d43f45dfd5b739638928db22d3f3392685 +Author: Michael Palimaka <kensing...@gentoo.org> +Date: Tue Oct 3 21:43:03 2017 +1100 + + dev-qt/qtphonon: remove last rited package + + Closes: https://bugs.gentoo.org/629144 +</pre> + +</body> +</section> +</chapter> +</guide> diff --git a/ebuild-maintenance/text.xml b/ebuild-maintenance/text.xml index 49a7fe1..b298807 100644 --- a/ebuild-maintenance/text.xml +++ b/ebuild-maintenance/text.xml @@ -20,6 +20,7 @@ This section covers various tasks related to working with ebuilds. <include href="new-ebuild/"/> <include href="git/"/> <include href="package-moves/"/> +<include href="removal/"/> <include href="stabilization/"/> <include href="maintenance-tasks/"/> </guide>
