Runtimes/Supplemental/Readme.md
The supplemental libraries are all libraries that are not one of the Core or overlay libraries. Each supplemental library builds as an independent project.
The supplemental libraries are:
The top-level Supplemental CMakeLists supplies a super-build pattern for
configuring and compiling each of the supplemental library projects through a
single CMake invocation. The Swift_ENABLE_RUNTIMES CMake option enables the
specified supplemental libraries. All libraries configured this way are built
with the same compilers, against the same sysroot, with the same target triple
and installed into the same location.
Configuring each project independently is tedious. The Supplemental directory contains a Super-Build CMakeLists that invokes the build of each of the supplemental libraries in the appropriate order, simplifying the process of building each library.
Important configuration variables:
Swift_ENABLE_RUNTIMES: Used to configure which runtime libraries are built.The super-build forwards the following variables to each sub-project unconditionally:
BUILD_SHARED_LIBSCMAKE_BUILD_TYPECMAKE_INSTALL_PREFIXCMAKE_COLOR_DIAGNOSTICSCMAKE_C_COMPILERCMAKE_C_COMPILER_TARGETCMAKE_CXX_COMPILERCMAKE_CXX_COMPILER_TARGETCMAKE_Swift_COMPILERCMAKE_Swift_COMPILER_TARGETIf set, the super-build forwards the following values to each sub-project:
SwiftCore_DIR: Path to the SwiftCore build directoryCMAKE_MAKE_PROGRAM: Path to ninjaThe super-build is for convenience. If more fine-grained control is desired for configuring a specific runtime library, you may configure that library independently.