From Fedora Project Wiki
(Detailed Description)
(Add trackers)
 
(12 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{admon/important | Comments and Explanations | The page source contains comments providing guidance to fill out each section. They are invisible when viewing this page. To read it, choose the "view source" link.<br/> '''Copy the source to a ''new page'' before making changes!  DO NOT EDIT THIS TEMPLATE FOR YOUR CHANGE PROPOSAL.'''}}
 
 
 
<!-- Self Contained or System Wide Change Proposal?
 
<!-- Self Contained or System Wide Change Proposal?
 
Use this guide to determine to which category your proposed change belongs to.
 
Use this guide to determine to which category your proposed change belongs to.
Line 54: Line 52:
 
CLOSED as NEXTRELEASE -> change is completed and verified and will be delivered in next release under development
 
CLOSED as NEXTRELEASE -> change is completed and verified and will be delivered in next release under development
 
-->
 
-->
* Tracker bug: <will be assigned by the Wrangler>
+
* Tracker bug: [https://bugzilla.redhat.com/show_bug.cgi?id=1790581 #1790581]
* Release notes tracker: <will be assigned by the Wrangler>
+
* Release notes tracker: [https://pagure.io/fedora-docs/release-notes/issue/431 #431]
  
 
== Detailed Description ==
 
== Detailed Description ==
Line 61: Line 59:
 
<!-- Expand on the summary, if appropriate.  A couple sentences suffices to explain the goal, but the more details you can provide the better. -->
 
<!-- Expand on the summary, if appropriate.  A couple sentences suffices to explain the goal, but the more details you can provide the better. -->
  
The gcc package currently installs symlinks to /usr/bin/cc and /usr/bin/c++ which point to /usr/bin/gcc and /usr/bin/g++ respectively.  For this change, the gcc package will be modified so that update-alternatives creates these symlinks.
+
The gcc package currently installs symlinks to /usr/bin/cc and /usr/bin/c++ which point to /usr/bin/gcc and /usr/bin/g++ respectively.  For this change, the gcc package will be modified so that update-alternatives creates and manages these symlinks.
  
In addition to modifying the gcc package, the clang package will also be modified so that /usr/bin/clang and /usr/bin/clang++ can be used as alternatives for /usr/bin/cc and /usr/bin/c++.  The clang alternatives will have a lower priority than the gcc alternatives, so that by default, gcc will provide the /usr/bin/cc and /usr/bin/c++ implementations.
+
In addition to modifying the gcc package, the clang package will be modified so that /usr/bin/clang and /usr/bin/clang++ can be used as alternatives for /usr/bin/cc and /usr/bin/c++.  The clang alternatives will have a lower priority than the gcc alternatives, so that by default, gcc will provide the /usr/bin/cc and /usr/bin/c++ implementations.
  
 
The clang package currently has a run-time dependency on gcc, so this ensures that gcc will always provide the default implementation, because it's impossible to install clang without gcc.
 
The clang package currently has a run-time dependency on gcc, so this ensures that gcc will always provide the default implementation, because it's impossible to install clang without gcc.
Line 99: Line 97:
 
-->
 
-->
  
Many build systems default to using /usr/bin/cc and /usr/bin/c++ as the default C/C++ compilers.  Being able to easily swap out these implementation will provide a lot of flexibility within Fedora for doing things like setting up alternative buildroots for testing or adding a wrapper script around gcc to aid in implementing some kinds of system wide changes like changes to the default compiler flags.
+
Many build systems default to using /usr/bin/cc and /usr/bin/c++ as the default C/C++ compilers.  Being able to easily swap out these implementation will provide a lot of flexibility within Fedora for doing things like:
 +
 
 +
* Setting up alternative buildroots for testing.
 +
* Installing a gcc wrapper script to /usr/bin/cc to help migrate packages to new compiler flags or to capture statistics about compiler usage.
 +
* Letting users experiment easily with alternate compilers.
 +
* Easily switch between system gcc and a development version of gcc.
  
 
== Scope ==
 
== Scope ==
Line 108: Line 111:
 
<!-- 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?-->
 
<!-- 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?-->
  
* Release engineering: [https://pagure.io/releng/issues #Releng issue number] (a check of an impact with Release Engineering is needed) <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
+
* Release engineering: [https://pagure.io/releng/issues/9120] (a check of an impact with Release Engineering is needed) <!-- 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.  
 
<!-- 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 -->
 
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 162: Line 165:
  
 
<!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
 
<!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
N/A (not a System Wide Change)
+
 
 +
This change has no other dependencies besides the changes to the gcc and clang packages.
  
 
== Contingency Plan ==
 
== Contingency Plan ==
Line 178: Line 182:
  
 
<!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
 
<!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
N/A (not a System Wide Change)
+
Release notes will be added for this change.
  
 
== Release Notes ==
 
== Release Notes ==
Line 187: Line 191:
 
-->
 
-->
  
[[Category:ChangePageIncomplete]]
+
The user /usr/bin/cc and /usr/bin/c++ symlinks are now managed by update-alternatives.  If you would like to change these symlinks to point to another compiler, like clang, for example, you can use these commands:
 +
 
 +
`update-alternatives --set cc /usr/bin/clang`
 +
 
 +
`update-alternatives --set c++ /usr/bin/clang++`
 +
 
 +
[[Category:ChangeAcceptedF32]]
 
<!-- 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 194: Line 204:
  
 
<!-- Select proper category, default is Self Contained Change -->
 
<!-- Select proper category, default is Self Contained Change -->
[[Category:SelfContainedChange]]
+
<!--[[Category:SelfContainedChange]]-->
<!-- [[Category:SystemWideChange]] -->
+
[[Category:SystemWideChange]]

Latest revision as of 16:50, 13 January 2020


Use update-alternatives for /usr/bin/cc and /usr/bin/c++

Summary

Modify the gcc package so that the /usr/bin/cc and /usr/bin/c++ symlinks are managed by update-alternatives.

Owner

Current status

Detailed Description

The gcc package currently installs symlinks to /usr/bin/cc and /usr/bin/c++ which point to /usr/bin/gcc and /usr/bin/g++ respectively. For this change, the gcc package will be modified so that update-alternatives creates and manages these symlinks.

In addition to modifying the gcc package, the clang package will be modified so that /usr/bin/clang and /usr/bin/clang++ can be used as alternatives for /usr/bin/cc and /usr/bin/c++. The clang alternatives will have a lower priority than the gcc alternatives, so that by default, gcc will provide the /usr/bin/cc and /usr/bin/c++ implementations.

The clang package currently has a run-time dependency on gcc, so this ensures that gcc will always provide the default implementation, because it's impossible to install clang without gcc.

The only way users will be able to change the /usr/bin/cc or /usr/bin/c++ implementations will be by explicitly using the update-alternatives tool.

Benefit to Fedora

Many build systems default to using /usr/bin/cc and /usr/bin/c++ as the default C/C++ compilers. Being able to easily swap out these implementation will provide a lot of flexibility within Fedora for doing things like:

  • Setting up alternative buildroots for testing.
  • Installing a gcc wrapper script to /usr/bin/cc to help migrate packages to new compiler flags or to capture statistics about compiler usage.
  • Letting users experiment easily with alternate compilers.
  • Easily switch between system gcc and a development version of gcc.

Scope

  • Proposal owners: The proposal owner will implement the necessary changes in the gcc and clang packages.
  • Other developers: The gcc maintainers will be responsible for reviewing and approving changes to the gcc package.
  • Release engineering: [1] (a check of an impact with Release Engineering is needed)
  • Policies and guidelines: No policies or guidelines will need to be updated as a result of this change.
  • Trademark approval: N/A (not needed for this Change)

Upgrade/compatibility impact

This change should not impact upgradeability.

How To Test

CI tests will be added to the gcc package to ensure that /usr/bin/cc and /usr/bin/c++ still point to /usr/bin/gcc and /usr/bin/g++ when installed. There will also be a CI test added to the clang package to ensure that /usr/bin/gcc and /usr/bin/g++ remain the default when clang is installed.

User Experience

This change will give users a much better way to experiment using other compilers for their own development. They will be able to easily switch between different compilers without having to modify their projects build system or make non-standard changes to their Fedora system.

Dependencies

This change has no other dependencies besides the changes to the gcc and clang packages.

Contingency Plan

  • Contingency mechanism: (What to do? Who will do it?) Proposal Owner will revert changes made to gcc and clang packages and rebuild.
  • Contingency deadline: If the changes are not complete by 2 weeks before the mass rebuild, then we will consider postponing to the next Fedora release and back out any changes that were made.
  • Blocks release? No
  • Blocks product? None

Documentation

Release notes will be added for this change.

Release Notes

The user /usr/bin/cc and /usr/bin/c++ symlinks are now managed by update-alternatives. If you would like to change these symlinks to point to another compiler, like clang, for example, you can use these commands:

update-alternatives --set cc /usr/bin/clang

update-alternatives --set c++ /usr/bin/clang++