< Changes
m (Add trackers) |
|||
| (11 intermediate revisions by 2 users not shown) | |||
| Line 6: | Line 6: | ||
<!-- 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 --> | <!-- 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 --> | ||
= %set_build_flags for %build and % | = %set_build_flags for %build, %check, and %install phases = | ||
<!-- The name of your change proposal --> | <!-- The name of your change proposal --> | ||
== Summary == | == Summary == | ||
Call %set_build_flags macro automatically at the beginning of the %build and % | Call %set_build_flags macro automatically at the beginning of the %build, %check, and %install phases of RPM builds in Fedora Linux. This will ensure that the compiler flag environment variables are set for every RPM build. | ||
<!-- 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?". --> | <!-- 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?". --> | ||
| Line 24: | Line 24: | ||
* FESCo shepherd: [[User:FASAccountName| Shehperd name]] <email address> | * FESCo shepherd: [[User:FASAccountName| Shehperd name]] <email address> | ||
--> | --> | ||
== Current status == | == Current status == | ||
[[Category: | [[Category:ChangeAcceptedF36]] | ||
<!-- When your change proposal page is completed and ready for review and announcement --> | <!-- When your change proposal page is completed and ready for review and announcement --> | ||
<!-- remove Category:ChangePageIncomplete and change it to Category:ChangeReadyForWrangler --> | <!-- remove Category:ChangePageIncomplete and change it to Category:ChangeReadyForWrangler --> | ||
| Line 45: | Line 44: | ||
ON_QA -> change is fully code complete | ON_QA -> change is fully code complete | ||
--> | --> | ||
* FESCo issue: | * [https://lists.fedoraproject.org/archives/list/devel@lists.fedoraproject.org/thread/OTEHEECFX2KOR2ILS6W35AYXONN5YWZP/ devel thread] | ||
* Tracker bug: | * FESCo issue: [https://pagure.io/fesco/issue/2728 #2728] | ||
* Release notes tracker: <will be assigned by the Wrangler> | * Tracker bug: [https://bugzilla.redhat.com/show_bug.cgi?id=2040430 #2040430] | ||
* Release notes tracker: <will be not assigned by the Wrangler: not user-facing> | |||
== Detailed Description == | == Detailed Description == | ||
| Line 65: | Line 65: | ||
These environment variables are set to the compiler flags defined in the system RPM configuration. This macro is currently implicitly called when packages use some of the build system helper macros, like %configure, %cmake, and %meson. However, not all packages use these macros and so some packages do not use the correct compiler flags as required by the Fedora packaging guidelines[1]. | These environment variables are set to the compiler flags defined in the system RPM configuration. This macro is currently implicitly called when packages use some of the build system helper macros, like %configure, %cmake, and %meson. However, not all packages use these macros and so some packages do not use the correct compiler flags as required by the Fedora packaging guidelines[1]. | ||
This change will be implemented by updating the %__spec_build_pre | This change will be implemented by updating the %__spec_build_pre, %__speck_check_pre, and __spec_install_pre macros in redhat-rpm-config to include %set_build_flags. This will set these environment variables automatically before the %build, %check, and %install phases. See the proposed [https://src.fedoraproject.org/rpms/redhat-rpm-config/pull-request/166 implementation] for more details. | ||
The purpose for making this change in | The purpose for making this change in the %check phase is because sometimes test code gets built in the %check phase for unit tests and this will ensure that the application code and its tests are built with the same set of flags. This change is also being made in the %install phase for a similar reason, because sometime code gets built during the install phase. | ||
This change should have no impact on packages that already use %set_build_flags either directly or indirectly through another macro. It also won't impact any package that currently sets these environment variables or modifies any of the %{build*_flags} macros in their %build or %check sections. | This change should have no impact on packages that already use %set_build_flags either directly or indirectly through another macro. It also won't impact any package that currently sets these environment variables or modifies any of the %{build*_flags} macros in their %build or %check sections. | ||
Packagers may opt out of this behavior by doing: | |||
%undefine _auto_set_build_flags | |||
[1] https://docs.fedoraproject.org/en-US/packaging-guidelines/#_compiler_flags | [1] https://docs.fedoraproject.org/en-US/packaging-guidelines/#_compiler_flags | ||
| Line 75: | Line 79: | ||
== Feedback == | == 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. --> | <!-- 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. --> | ||
Based on feedback on the devel list, the following changes were made: | |||
* Added %set_build_flags to the %install phase. | |||
* Added an opt-out mechanism: | |||
%undefine _auto_set_build_flags | |||
== Benefit to Fedora == | == Benefit to Fedora == | ||
| Line 188: | Line 199: | ||
<!-- REQUIRED FOR SYSTEM WIDE CHANGES --> | <!-- REQUIRED FOR SYSTEM WIDE CHANGES --> | ||
None needed. | |||
== Release Notes == | == Release Notes == | ||
Latest revision as of 17:03, 13 January 2022
%set_build_flags for %build, %check, and %install phases
Summary
Call %set_build_flags macro automatically at the beginning of the %build, %check, and %install phases of RPM builds in Fedora Linux. This will ensure that the compiler flag environment variables are set for every RPM build.
Owner
- Name: Tom Stellard
- Email: <tstellar@redhat.com>
Current status
- Targeted release: Fedora Linux 36
- Last updated: 2022-01-13
- devel thread
- FESCo issue: #2728
- Tracker bug: #2040430
- Release notes tracker: <will be not assigned by the Wrangler: not user-facing>
Detailed Description
The %set_build_flags macro exports common environment variables used for building packages:
- CFLAGS
- CXXFLAGS
- FFLAGS
- FCFLAGS
- LDFLAGS
- LT_SYS_LIBRARY_PATH
- CC
- CXX
These environment variables are set to the compiler flags defined in the system RPM configuration. This macro is currently implicitly called when packages use some of the build system helper macros, like %configure, %cmake, and %meson. However, not all packages use these macros and so some packages do not use the correct compiler flags as required by the Fedora packaging guidelines[1].
This change will be implemented by updating the %__spec_build_pre, %__speck_check_pre, and __spec_install_pre macros in redhat-rpm-config to include %set_build_flags. This will set these environment variables automatically before the %build, %check, and %install phases. See the proposed implementation for more details.
The purpose for making this change in the %check phase is because sometimes test code gets built in the %check phase for unit tests and this will ensure that the application code and its tests are built with the same set of flags. This change is also being made in the %install phase for a similar reason, because sometime code gets built during the install phase.
This change should have no impact on packages that already use %set_build_flags either directly or indirectly through another macro. It also won't impact any package that currently sets these environment variables or modifies any of the %{build*_flags} macros in their %build or %check sections.
Packagers may opt out of this behavior by doing:
%undefine _auto_set_build_flags
[1] https://docs.fedoraproject.org/en-US/packaging-guidelines/#_compiler_flags
Feedback
Based on feedback on the devel list, the following changes were made:
- Added %set_build_flags to the %install phase.
- Added an opt-out mechanism:
%undefine _auto_set_build_flags
Benefit to Fedora
This change will ensure that more packages are built using the correct compiler flags, and bring them in compliance with the Fedora packaging guidelines. It will also help improve the security of the distribution as many of the compiler flags help defend against common security attacks.
Scope
- Proposal owners:
- Make the necessary changes to redhat-rpm-config.
- Help debug any issues uncovered by this change during the mass rebuild.
- Other developers:
- Report bugs to the proposal owner.
- Release engineering: #10482
- 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
How To Test
This change will be tested by rebuilding packages as part of the mass rebuild.
User Experience
This change will make some packages less susceptible to security exploits.
Dependencies
Contingency Plan
- Contingency mechanism: The proposal owner will revert the change in redhat-rpm-config
- Contingency deadline: Beta Freeze
- Blocks release? No
Documentation
None needed.