From 1da79ea0ff0325befb13cc99a548f55c9300ac77 Mon Sep 17 00:00:00 2001 From: Matthijs van der Burgh Date: Thu, 8 Apr 2021 13:55:49 +0200 Subject: [PATCH 1/4] Pip entries anchoring and aliasing --- CONTRIBUTING.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 276f198466005..e4345bc7fe314 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -177,6 +177,24 @@ python3-foobar-pip: packages: [foobar] ``` +In constrast to normal python entries, which are often different for python 2 and 3, pip entries for python 2 and 3 are almost always identical. +Hence no new entry would be needed. Though this would leave us with a mess of `python3-*`, `python-*-pip` and `python3-*-pip` entries. +To prevent this, the `python3-*-pip` entry should be mapped to the legacy `python-*-pip` entry by using yaml anchors and aliases. +(Prerabbly this was the other way around. So the `python3-*-pip` entry containing the contents and the anchor and the legacy `python-*-pip` entry being aliased to it. +Though the anchor should be defined before the anchor is used and `python3-` entries come after `python-` entries in alphabetical order.) + +For example: + +```yaml +python-foobar-pip: &migrate_eol_2025_04_30_python3_foobar_pip # Anchor + ubuntu: + pip: + packages: [foobar] +python3-foobar-pip: *migrate_eol_2025_04_30_python3_foobar_pip # Alias +``` + +The anchor/alias should be formatted as `migrate_eol___
_`. + Some existing rules do not have `python-` or `python3-` prefixes, but this is no longer recommended. If the package ever becomes available in Debian or Ubuntu, the `python3-` prefix ensures that the `pip` key is next to it alphabetically. The `-pip` key should be removed when the package becomes available on all platforms, and all existing users of the `-pip` key should migrate to the new key. From 8ffe16b9ff5f5364a522fcad28dc69e61ef76247 Mon Sep 17 00:00:00 2001 From: Matthijs van der Burgh Date: Tue, 13 Apr 2021 09:30:59 +0200 Subject: [PATCH 2/4] Fix typo Co-authored-by: Tully Foote --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e4345bc7fe314..865808f54eb61 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -180,7 +180,7 @@ python3-foobar-pip: In constrast to normal python entries, which are often different for python 2 and 3, pip entries for python 2 and 3 are almost always identical. Hence no new entry would be needed. Though this would leave us with a mess of `python3-*`, `python-*-pip` and `python3-*-pip` entries. To prevent this, the `python3-*-pip` entry should be mapped to the legacy `python-*-pip` entry by using yaml anchors and aliases. -(Prerabbly this was the other way around. So the `python3-*-pip` entry containing the contents and the anchor and the legacy `python-*-pip` entry being aliased to it. +(Preferably this was the other way around. So the `python3-*-pip` entry containing the contents and the anchor and the legacy `python-*-pip` entry being aliased to it. Though the anchor should be defined before the anchor is used and `python3-` entries come after `python-` entries in alphabetical order.) For example: From 2d745f0fada5e165c937289fb9d4a5fe68f39676 Mon Sep 17 00:00:00 2001 From: Matthijs van der Burgh Date: Thu, 15 Apr 2021 17:45:42 +0200 Subject: [PATCH 3/4] fix typo Co-authored-by: Scott K Logan --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 865808f54eb61..c236a30c09bfc 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -177,7 +177,7 @@ python3-foobar-pip: packages: [foobar] ``` -In constrast to normal python entries, which are often different for python 2 and 3, pip entries for python 2 and 3 are almost always identical. +In contrast to normal python entries, which are often different for python 2 and 3, pip entries for python 2 and 3 are almost always identical. Hence no new entry would be needed. Though this would leave us with a mess of `python3-*`, `python-*-pip` and `python3-*-pip` entries. To prevent this, the `python3-*-pip` entry should be mapped to the legacy `python-*-pip` entry by using yaml anchors and aliases. (Preferably this was the other way around. So the `python3-*-pip` entry containing the contents and the anchor and the legacy `python-*-pip` entry being aliased to it. From ab459b918efc8be45aa818431cb45f28af63a424 Mon Sep 17 00:00:00 2001 From: Matthijs van der Burgh Date: Fri, 16 Apr 2021 12:40:36 +0200 Subject: [PATCH 4/4] (CONTRIBUTING) explain EOL date of Pip entry anchor/alias --- CONTRIBUTING.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c236a30c09bfc..f23c898e129e3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -195,6 +195,8 @@ python3-foobar-pip: *migrate_eol_2025_04_30_python3_foobar_pip # Alias The anchor/alias should be formatted as `migrate_eol___
_`. +The EOL date of the entry should match the EOL date of the longest supported current platform. + Some existing rules do not have `python-` or `python3-` prefixes, but this is no longer recommended. If the package ever becomes available in Debian or Ubuntu, the `python3-` prefix ensures that the `pip` key is next to it alphabetically. The `-pip` key should be removed when the package becomes available on all platforms, and all existing users of the `-pip` key should migrate to the new key.