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 1: / Line 1: @@
 <!-- The actual name of your proposed change page should look something like: Changes/Your_Change_Proposal_Name.  This keeps all change proposals in the same namespace -->
-= Split Gettext Package =
+= Gettext Runtime Subpackage =
-<!-- The name of your change proposal -->
 == Summary ==
 <!-- A sentence or two summarizing what this change is and what it will do. This information is used for the overall changeset summary page for each release. Note that motivation for the change should be in the Benefit to Fedora section below, and this part should answer the question "What?" rather than "Why?". -->
-Extracting the heavier part "tools" from the gettext (main) package into a separate sub-package.
+Subpackage gettext's runtime programs in a small runtime subpackage, reducing the default install footprint.
 == Owner ==
 <!--
 For change proposals to qualify as self-contained, owners of all affected packages need to be included here. Alternatively, a SIG can be listed as an owner if it owns all affected packages.
 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
 <!--- UNCOMMENT only for Changes with assigned Shepherd (by FESCo)
 * FESCo shepherd: [[User:FASAccountName| Shehperd name]] <email address>
 -->
 == Current status ==
-[[Category:ChangePageIncomplete]]
 <!-- When your change proposal page is completed and ready for review and announcement -->
 <!-- remove Category:ChangePageIncomplete and change it to Category:ChangeReadyForWrangler -->
 <!-- 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:ChangeAcceptedF37]]
+<!-- [[Category:ChangeReadyForWrangler]]-->
 <!-- Select proper category, default is Self Contained Change -->
 <!-- [[Category:SelfContainedChange]] -->
 [[Category:SystemWideChange]]
 * Targeted release: [[Releases/37 | Fedora Linux 37 ]]
 * Last updated: <!-- this is an automatic macro — you don't need to change this line -->  {{REVISIONYEAR}}-{{REVISIONMONTH}}-{{REVISIONDAY2}}
 <!-- After the change proposal is accepted by FESCo, tracking bug is created in Bugzilla and linked to this page
 Bugzilla state meanings:
 ASSIGNED -> accepted by FESCo with ongoing development
@@ Line 40: / Line 38: @@
 ON_QA -> change is fully code complete
 -->
-* [https://lists.fedoraproject.org/archives/list/devel@lists.fedoraproject.org/thread/CRMFB7JBI3HJOANYZFVL3UVW55RCZ64H/ devel thread]
+* [https://lists.fedoraproject.org/archives/list/devel@lists.fedoraproject.org/thread/D24H2E6WW4BB6KYRMDO5HCPZLEUTFWD6/ devel thread]
-* FESCo issue:
+* FESCo issue: [https://pagure.io/fesco/issue/2818 #2818]
-* Tracker bug:
+* Tracker bug: [https://bugzilla.redhat.com/show_bug.cgi?id=2103239 #2103239]
-* Release notes tracker:
+* 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. It's install ''uncompressed'' size is about ~'''6.1''' MB. A large number of packages directly or indirectly depend on it. Extracting "tools" from gettext ''main'' package into a separate sub-package would reduce the footprint. Hence a saving of ~'''4.7''' MB on most normal installations.
+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 split this should look like:
+After the split this should look like:
 <pre>
-gettext package
+gettext-runtime subpackage
---------------------
+-----------------------
 compressed size: 172 kB
-uncompressed size: 749.6 kB
+uncompressed size: 749.6 kB
-gettext-tools subpackage
+gettext package
 ------------------------
 compressed size: 1.0 MB
 uncompressed size: 4.7 MB
-As gettext depends on gettext-libs:
+As gettext-runtime depends on gettext-libs:
 gettext-libs subpackage
 -----------------------
 compressed size: 322K
-uncompressed size: 933.7 kB
+uncompressed size: 933.7 kB
 </pre>
 Grouping of binaries:
 <pre>
-gettext:
+gettext-runtime:
 envsubst gettext gettext.sh ngettext
-gettext-tools:
+gettext:
 msgattrib msgcat msgcmp msgcomm msgconv msgen msgexec msgfilter msgfmt msggrep msginit msgmerge msgunfmt msguniq recode-sr-latin xgettext
 </pre>
@@ Line 81: / Line 81: @@
 == Feedback ==
 <!-- Summarize the feedback from the community and address why you chose not to accept proposed alternatives. This section is optional for all change proposals but is strongly suggested. Incorporating feedback here as it is raised gives FESCo a clearer view of your proposal and leaves a good record for the future. If you get no feedback, that is useful to note in this section as well. For innovative or possibly controversial ideas, consider collecting feedback before you file the change proposal. -->
+* initial [https://lists.fedoraproject.org/archives/list/devel@lists.fedoraproject.org/thread/CRMFB7JBI3HJOANYZFVL3UVW55RCZ64H/ devel thread] floating subpackaging idea (April 2022)
 == Benefit to Fedora ==
 <!-- What is the benefit to the distribution?  Will the software we generate be improved? How will the process of creating Fedora releases be improved?
        Be sure to include the following areas if relevant:
        If this is a major capability update, what has changed?
@@ Line 99: / Line 101: @@
             For example: Gating Fedora packages on automatic QA tests will make rawhide more stable and allow changes to be implemented more smoothly.
        Is this an improvement targeted as specific contributors?
             For example: Ensuring that a minimal set of tools required for contribution to Fedora are installed by default eases the onboarding of new contributors.
       When a Change has multiple benefits, it's better to list them all.
@@ Line 110: / Line 112: @@
       https://fedoraproject.org/wiki/Changes/perl5.26 (major upgrade to a popular software stack, visible to users of that stack)
 -->
-Space saving of about ~'''4.7''' MB on most of the normal installations.
+Space saving of about ~4.7 MB for typical installations.
 == Scope ==
 * 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 owns packages implicitly expects '''gettext-tools''' a new sub package. May need to update the dependency from "gettext" to "gettext-tools".
+** 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 -->
@@ Line 130: / Line 136: @@
 <!-- If your Change may require trademark approval (for example, if it is a new Spin), file a ticket ( https://pagure.io/Fedora-Council/tickets/issues ) requesting trademark approval from the Fedora Council. This approval will be done via the Council's consensus-based process. -->
 * Alignment with Objectives:
 <!-- Does your proposal align with the current Fedora Objectives: https://docs.fedoraproject.org/en-US/project/objectives/ ? It's okay if it doesn't, but it's something to consider -->
 == Upgrade/compatibility impact ==
 <!-- What happens to systems that have had a previous versions of Fedora installed and are updated to the version containing this change? Will anything require manual configuration or data migration? Will any existing functionality be no longer supported? -->
-Both "gettext" and "gettext-tools" obsoletes earlier version of gettext. <br/>So, on '''update''' both packages will get installed on systems having gettext. (''preinstalled'')
+Impact should be low: on upgrade both packages will get installed on systems that had gettext installed.
 <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
 == How To Test ==
 <!-- This does not need to be a full-fledged document. Describe the dimensions of tests that this change implementation is expected to pass when it is done.  If it needs to be tested with different hardware or software configurations, indicate them.  The more specific you can be, the better the community testing can be.
 Remember that you are writing this how to for interested testers to use to check out your change implementation - documenting what you do for testing is OK, but it's much better to document what *I* can do to test your change.
@@ Line 153: / Line 159: @@
 . What are the expected results of those actions?
 -->
+* 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
 <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
 == User Experience ==
@@ Line 168: / Line 176: @@
   - Green has been scientifically proven to be the most relaxing color. The move to a default background color of green with green text will result in Fedora users being the most relaxed users of any operating system.
 -->
-User will see lighter gettext package and a new gettext-tools package. <br/>Many of the desktop/web apps/libraries use gettext-tools. They would need to update their dependency to "gettext-tools" now.
+User will see a new lighter gettext-runtime package and a gettext package. <br/>This subpackage separation also corresponds to the recommended packaging by upstream and Debian's gettext-base and gettext packages.
 == Dependencies ==
@@ Line 174: / Line 182: @@
 <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
-Packages which explicitly has a dependency to gettext are basically need to check for binary they are dependent on. And if that belongs to gettext-tool, they need to update their dependency to "gettext-tools" from gettext.
+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>.
-Furthermore, gettext-tools has a dependency to 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 ==
 <!-- If you cannot complete your feature by the final development freeze, what is the backup plan?  This might be as simple as "Revert the shipped configuration".  Or it might not (e.g. rebuilding a number of dependent packages).  If you feature is not completed in time we want to assure others that other parts of Fedora will not be in jeopardy.  -->
-* Contingency mechanism: (What to do?  Who will do it?) Revert the relevant packages updated.  <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
+* Contingency mechanism: (What to do?  Who will do it?) Package owners to revert relevant packages.  <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
 <!-- When is the last time the contingency mechanism can be put in place?  This will typically be the beta freeze. -->
 * Contingency deadline: Beta freeze  <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
@@ Line 189: / Line 199: @@
 == Documentation ==
 <!-- Is there upstream documentation on this change, or notes you have written yourself?  Link to that material here so other interested developers can get involved. -->
+https://git.savannah.gnu.org/gitweb/?p=gettext.git;a=blob;f=PACKAGING
 <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
-None.
 == Release Notes ==
 <!-- The Fedora Release Notes inform end-users about what is new in the release.  Examples of past release notes are here: http://docs.fedoraproject.org/release-notes/ -->
 <!-- The release notes also help users know how to deal with platform changes such as ABIs/APIs, configuration or data file formats, or upgrade concerns.  If there are any such changes involved in this change, indicate them here.  A link to upstream documentation will often satisfy this need.  This information forms the basis of the release notes edited by the documentation team and shipped with the release.
 Release Notes are not required for initial draft of the Change Proposal but has to be completed by the Change Freeze.
 -->
+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