Latest revision as of 08:55, 7 September 2022

Gettext Runtime Subpackage

Summary

Subpackage gettext's runtime programs in a small runtime subpackage, reducing the default install footprint.

Owner

Name: Sundeep ANAND, Jens Petersen
Email: suanand@redhat.com, petersen@redhat.com

Current status

Targeted release: Fedora Linux 37
Last updated: 2022-09-07
devel thread
FESCo issue: #2818
Tracker bug: #2103239
Release notes tracker: #852

Detailed Description

Gettext is one of the core packages. Its installed on-disk size is about ~6.1 MB. Extracting runtime utilities from main gettext package into a separate sub-package will reduce the default system footprint by about ~4.7 MB on most normal installations.

Note further that envsubst has also been split out into the gettext-envsubst subpackage allowing it to be installed independently.

After the split this should look like:

gettext-runtime subpackage
-----------------------
compressed size: 172 kB
uncompressed size: 749.6 kB

gettext package
------------------------
compressed size: 1.0 MB
uncompressed size: 4.7 MB

As gettext-runtime depends on gettext-libs:

gettext-libs subpackage
-----------------------
compressed size: 322K
uncompressed size: 933.7 kB

Grouping of binaries:

gettext-runtime:
envsubst gettext gettext.sh ngettext

gettext:
msgattrib msgcat msgcmp msgcomm msgconv msgen msgexec msgfilter msgfmt msggrep msginit msgmerge msgunfmt msguniq recode-sr-latin xgettext

Feedback

initial devel thread floating subpackaging idea (April 2022)

Benefit to Fedora

Space saving of about ~4.7 MB for typical installations.

Scope

Proposal owners:
- Add Provides: gettext-runtime to gettext [done in rawhide]
- Update the gettext package in rawhide to have the new gettext-runtime subpackage, pulled in by the gettext base package (PR)
- File bugs against packages that could be changed to only need gettext-runtime at runtime.
- Subpackage envsubst as a mini-subpackage of gettext-runtime (bz)

Other developers:
- Packagers who own packages that have a direct runtime dependency on gettext (roughly 30 packages) and that actually only need gettext-runtime can change their Requires: gettext to the new gettext-runtime subpackage in Rawhide.

Release engineering: #10836

Policies and guidelines: N/A (not needed for this Change)

Trademark approval: N/A (not needed for this Change)

Alignment with Objectives:

Upgrade/compatibility impact

Impact should be low: on upgrade both packages will get installed on systems that had gettext installed.

How To Test

Test upgrades from F36 to F37
Test minimal/default installs continue to work as expected
Packages that depend on gettext continue to rebuild, install, and function normally

User Experience

User will see a new lighter gettext-runtime package and a gettext package.
This subpackage separation also corresponds to the recommended packaging by upstream and Debian's gettext-base and gettext packages.

Dependencies

Packages which explicitly have a dependency on gettext need to check if they only need programs provided by gettext-runtime, and if so they can update their dependency to gettext-runtime from gettext.

Only about 33 Fedora packages currently require gettext (whereas almost 1200 packages have a buildtime dependency):

NsCDE backup-manager blivet-gui byobu debootstrap deepin-gettext-tools ecryptfs-utils fontconfig gambas3 gnome-books gnome-common grub2 ibus ibus-chewing kf5-ki18n libpst libvirt lokalize mate-common osmo photocollage playonlinux po-debconf po4a poedit redhat-lsb rpminspect sensible-utils sugar-toolkit-gtk3 translate-toolkit vdr vim-syntastic yast2-devtools

Contingency Plan

Contingency mechanism: (What to do? Who will do it?) Package owners to revert relevant packages.
Contingency deadline: Beta freeze
Blocks release? No

Documentation

https://git.savannah.gnu.org/gitweb/?p=gettext.git;a=blob;f=PACKAGING

Release Notes

gettext-runtime and gettext-envsubst subpackages have been added to gettext to separate out the programs needed at runtime, reducing the default install footprint.

@@ Line 12: / Line 12: @@
 This should link to your home wiki page so we know who you are.
 -->
-* Name: [[User:Sundeep|Sundeep ANAND]]
+* Name: [[User:Sundeep|Sundeep ANAND]], [[User:Petersen|Jens Petersen]]
 <!-- Include you email address that you can be reached should people want to contact you about helping with your change, status is requested, or technical issues need to be resolved. If the change proposal is owned by a SIG, please also add a primary contact person. -->
-* Email: suanand@redhat.com
+* Email: suanand@redhat.com, petersen@redhat.com
-* Name: [[User:Petersen|Jens Petersen]]
-* Email: petersen@redhat.com
 <!--- UNCOMMENT only for Changes with assigned Shepherd (by FESCo)
 * FESCo shepherd: [[User:FASAccountName| Shehperd name]] <email address>
@@ Line 26: / Line 24: @@
 <!-- The Wrangler announces the Change to the devel-announce list and changes the category to Category:ChangeAnnounced (no action required) -->
 <!-- After review, the Wrangler will move your page to Category:ChangeReadyForFesco... if it still needs more work it will move back to Category:ChangePageIncomplete-->
-[[Category:ChangePageIncomplete]]
+[[Category:ChangeAcceptedF37]]
 <!-- [[Category:ChangeReadyForWrangler]]-->
 <!-- Select proper category, default is Self Contained Change -->
@@ Line 40: / Line 38: @@
 ON_QA -> change is fully code complete
 -->
-* FESCo issue:
+* [https://lists.fedoraproject.org/archives/list/devel@lists.fedoraproject.org/thread/D24H2E6WW4BB6KYRMDO5HCPZLEUTFWD6/ devel thread]
-* Tracker bug:
+* FESCo issue: [https://pagure.io/fesco/issue/2818 #2818]
-* Release notes tracker:
+* Tracker bug: [https://bugzilla.redhat.com/show_bug.cgi?id=2103239 #2103239]
+* Release notes tracker: [https://pagure.io/fedora-docs/release-notes/issue/852 #852]
 == Detailed Description ==
 <!-- Expand on the summary, if appropriate.  A couple sentences suffices to explain the goal, but the more details you can provide the better. -->
 Gettext is one of the core packages. Its installed on-disk size is about ~6.1 MB. Extracting runtime utilities from main gettext package into a separate sub-package will reduce the default system footprint by about ~4.7 MB on most normal installations.
+''Note further that envsubst has also been split out into the gettext-envsubst subpackage allowing it to be installed independently.''
 After the split this should look like:
@@ Line 116: / Line 117: @@
 * Proposal owners:
 <!-- What work do the feature owners have to accomplish to complete the feature in time for release?  Is it a large change affecting many parts of the distribution or is it a very isolated change? What are those changes?-->
+** Add <code>Provides: gettext-runtime</code> to <code>gettext</code> [done in rawhide]
 ** Update the gettext package in rawhide to have the new gettext-runtime subpackage, pulled in by the gettext base package ([https://src.fedoraproject.org/rpms/gettext/pull-request/15 PR])
 ** File bugs against packages that could be changed to only need gettext-runtime at runtime.
+** Subpackage envsubst as a mini-subpackage of gettext-runtime ([https://bugzilla.redhat.com/show_bug.cgi?id=2068556 bz])
 * Other developers: <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
 <!-- What work do other developers have to accomplish to complete the feature in time for release?  Is it a large change affecting many parts of the distribution or is it a very isolated change? What are those changes?-->
-** Packagers who own packages that have a direct runtime dependency on gettext (estimated under 30 packages) and that actually only need gettext-runtime can change their <code>Requires: gettext</code> to the new <code>gettext-runtime</code> subpackage in Rawhide (estimated around 10 Fedora packages).
+** Packagers who own packages that have a direct runtime dependency on gettext (roughly 30 packages) and that actually only need gettext-runtime can change their <code>Requires: gettext</code> to the new <code>gettext-runtime</code> subpackage in Rawhide.
-* Release engineering:  <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
+* Release engineering: [https://pagure.io/releng/issue/10836 #10836] <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
 <!-- Does this feature require coordination with release engineering (e.g. changes to installer image generation or update package delivery)?  Is a mass rebuild required?  include a link to the releng issue.
 The issue is required to be filed prior to feature submission, to ensure that someone is on board to do any process development work and testing and that all changes make it into the pipeline; a bullet point in a change is not sufficient communication -->
-** todo: link to ticket
 * Policies and guidelines: N/A (not needed for this Change) <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
@@ Line 157: / Line 159: @@
 . What are the expected results of those actions?
 -->
-* Preview test package is available from: https://copr.fedorainfracloud.org/coprs/suanand/gettext-runtime
 * Test upgrades from F36 to F37
 * Test minimal/default installs continue to work as expected
@@ Line 184: / Line 184: @@
 Packages which explicitly have a dependency on gettext need to check if they only need programs provided by gettext-runtime, and if so they can update their dependency to <code>gettext-runtime</code> from <code>gettext</code>.
-Roughly about ~26 Fedora packages require gettext (and around 1115 packages have build dependency).
+Only about 33 Fedora packages currently require gettext (whereas almost 1200 packages have a buildtime dependency):
+NsCDE backup-manager blivet-gui byobu debootstrap deepin-gettext-tools ecryptfs-utils fontconfig gambas3 gnome-books gnome-common grub2 ibus ibus-chewing kf5-ki18n libpst libvirt lokalize mate-common osmo photocollage playonlinux po-debconf po4a poedit redhat-lsb rpminspect sensible-utils sugar-toolkit-gtk3 translate-toolkit vdr vim-syntastic yast2-devtools
 == Contingency Plan ==
@@ Line 208: / Line 210: @@
 Release Notes are not required for initial draft of the Change Proposal but has to be completed by the Change Freeze.
 -->
-A gettext-runtime subpackage has been added to gettext to separate out the programs needed at runtime, reducing the default install footprint.
+gettext-runtime and gettext-envsubst subpackages have been added to gettext to separate out the programs needed at runtime, reducing the default install footprint.

Search

Changes/GettextRuntimeSubpackage: Difference between revisions