From Fedora Project Wiki


Stop shipping individual component libraries in clang-lib package

Summary

Remove the individual component libraries (e.g. libclangBasic.so, libclangAST.so) from the clang-lib package. Packages that depend on the clang libraries should instead link against libclang-cpp.so.

Owner

Current status

  • Targeted release: Fedora 32
  • Last updated: 2019-12-12
  • Tracker bug: <will be assigned by the Wrangler>
  • Release notes tracker: <will be assigned by the Wrangler>

Detailed Description

The individual component libraries will be removed from the clang-lib package in favor of libclang-cpp.so (which is already present in clang-libs). The component shared libraries enabled by the BUILD_SHARED=ON CMake option is not supported as a distribution configuration by the upstream project and only recommended for use by clang developers[1]

The libclang-cpp.so shared object was added in clang 9.0 and now gives us an alternative shared library option that is supported by the upstream project, which allows us to stop using the component libraries.

[1] https://llvm.org/docs/CMake.html

Benefit to Fedora

We will improve stability in Fedora by packaging a build configuration that is supported by the upstream project. In addition, the libclang-cpp.so will provide more LTO optimization opportunities than the component libraries if this option is enabled in Fedora builds. In order to access the clang API with the component libraries, and application might need to link with up to 37 different shared libraries, replacing these with a single shared library will help improve start-up times of applications that depend on clang.

Scope

  • Proposal owners:
    • The proposal owner will ensure that that all packages that depend on clang-libs(bcc, bpftrace, castxml, ccls, clazy, gnome-builder, ispc, kdevelop, lldb, mesa, pocl, qt-creator, qt5-doctools, shiboken2 tinygo) are updated to use libclang-cpp.so.
    • Once all packages have been updated, the clang package will be updated to pass -DBUILD_SHARED=OFF to cmake when configuring.
  • Other developers: The other maintainers will be responsible for reviewing and approving changes to their packages.
  • 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

This can be tested using existing CI tests or tests in the %check section of spec files. The changes should not be visible to end users so tests should behave exactly as they did before the change.

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++

Retrieved from "https://fedoraproject.org/w/index.php?title=Changes/Stop-Shipping-Individual-Component-Libraries-In-clang-lib-Package&oldid=560718"