summaryrefslogtreecommitdiffstats
path: root/Help/manual/cmake-variables.7.rst
Commit message (Collapse)AuthorAgeFilesLines
* Help: Document CMAKE_PLATFORM_NO_VERSIONED_SONAMERalf Habacker2022-02-141-0/+1
| | | | | | | This variable was added by commit 42f74df6d4 (Add basic Android platform module, 2014-06-06, v3.1.0-rc1~416^2), but was not previously documented. Fixes: #23227
* find_*(): Add CMAKE_IGNORE_PREFIX_PATH variableKyle Edwards2022-02-021-0/+2
| | | | Fixes: #20878
* Merge topic 'vs-package-restore'Brad King2022-01-241-0/+1
|\ | | | | | | | | | | | | | | | | | | 9aa7831f05 Presets: add resolve packages setting to build presets. b2f8f0bb87 cmGlobalVisualStudio10Generator: Auto restore NuGet packages. 193b8fca52 cmBuildOptions: Split build arguments into separate object. 6a10103493 Help: Update preset schema description for version 3 entries. Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !6761
| * cmGlobalVisualStudio10Generator: Auto restore NuGet packages.Carsten Rudolph2022-01-221-0/+1
| |
* | Help: Move linker preference variables to the internal sectionCraig Scott2022-01-151-2/+2
|/ | | | | | | These probably should not have been documented as public variables to begin with. But since they have been documented for a long time, we can't just remove them from the docs. Move them to the internal section instead to make it clearer that they are not intended to be used directly by projects.
* Merge topic 'vs-csharp-dotnet-sdk'Brad King2021-12-221-0/+1
|\ | | | | | | | | | | | | | | | | 0eea32a376 VS: Add DOTNET_SDK property to generate SDK-style C# projects a450cc9533 VS: Set ResolveNugetPackages to false for ALL_BUILD and ZERO_CHECK fa76e5d194 cmVisualStudio10TargetGenerator: Factor out helper for classic MSBuild project Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !6634
| * VS: Add DOTNET_SDK property to generate SDK-style C# projectsSumit Bhardwaj2021-12-211-0/+1
| | | | | | | | | | | | | | | | Changes in cmVisualStudio10TargetGenerator::Generate to write .Net SDK-style project for VS generators VS 19 and above. Also adds documentation and tests. Issue: #20227
* | target_link_libraries: Optionally require only target namesBrad King2021-12-201-0/+1
|/ | | | | | | | | | Optionally verify that items in `LINK_LIBRARIES` and `INTERFACE_LINK_LIBRARIES` that can be target names are actually target names. Add a `LINK_LIBRARIES_ONLY_TARGETS` target property and corresponding `CMAKE_LINK_LIBRARIES_ONLY_TARGETS` variable to enable this new check. Fixes: #22858
* GHS: GHSMULTI - Update documentation to match implementationFred Baksik2021-11-151-1/+1
| | | | * The variable being set was named `GHSMULTI` not `GHS-MULTI`.
* Merge topic 'xcode-generation-enablegpuframecapturemode'Brad King2021-11-121-0/+1
|\ | | | | | | | | | | | | | | | | 0798edfb85 Tests: Xcode scheme ENABLE_GPU_FRAME_CAPTURE_MODE e09a3eddb6 Xcode: Support "GPU Frame Capture" scheme property Acked-by: Kitware Robot <kwrobot@kitware.com> Tested-by: buildbot <buildbot@kitware.com> Merge-request: !6639
| * Xcode: Support "GPU Frame Capture" scheme propertyJake Turner2021-10-191-0/+1
| | | | | | | | | | | | | | | | | | | | | | Added XCODE_SCHEME_ENABLE_GPU_FRAME_CAPTURE_MODE variable which sets the scheme property value for "GPU Frame Capture" in the Options section by setting the Xcode project variable "enableGPUFrameCaptureMode". Example values are "Metal" (1) and "Disabled" (3). XCODE_SCHEME_ENABLE_GPU_FRAME_CAPTURE_MODE is initialized by the property CMAKE_XCODE_SCHEME_ENABLE_GPU_FRAME_CAPTURE_MODE. Implements: #22700
* | Merge topic 'vs-framework-version'Brad King2021-11-081-0/+3
|\ \ | |/ |/| | | | | | | | | | | | | | | d51246c662 VS: Default TargetFrameworkVersion to v4.7.2 for VS 2022 f97f8537f3 VS: Model a default target framework e40cedddc0 cmVisualStudio10TargetGenerator: Refactor target framework selection 78782cc7dc cmGlobalVisualStudio8Generator: Refactor SetGeneratorPlatform Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !6699
| * VS: Model a default target frameworkBrad King2021-11-061-0/+3
| | | | | | | | | | | | | | | | | | | | Add fields to the VS generator to select a target framework. Migrate the existing default for VS 12 .NET CF for Windows CE. Report the values in `CMAKE_VS_*` variables and use them for the CSharp compiler id project too. Issue: #22849
* | CTest: Add CTEST_SUBMIT_INACTIVITY_TIMEOUT variableNikhil Reddy Ramolla2021-10-141-0/+1
|/ | | | Fixes: #22617
* Help: Add documentation for CMAKE_<LANG>_COMPILER_FRONTEND_VARIANTDeniz Bahadir2021-10-131-0/+1
| | | | Signed-off-by: Deniz Bahadir <deniz@code.bahadir.email>
* Merge topic 'fetchcontent-CMAKE-vars-passthrough'Craig Scott2021-10-061-0/+1
|\ | | | | | | | | | | | | | | | | 1851aa49be FetchContent: Pass through networking-related CMAKE_... variables 96937438b7 Help: Clean up how TLS and NETRC variables are discussed 2a82bd85b6 Help: Add documentation for CMAKE_TLS_CAINFO Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !6589
| * Help: Add documentation for CMAKE_TLS_CAINFOCraig Scott2021-10-041-0/+1
| |
* | CompilerID: Compiler extensions default detectionRaul Tambre2021-09-281-0/+1
| |
* | Help: Document CMAKE_<LANG>_STANDARD_DEFAULTRaul Tambre2021-09-281-0/+1
| | | | | | | | Seems to be stable and will referred to by policy for standards flags rework.
* | Help: Document HIP standard/extensions properties and variablesRaul Tambre2021-09-281-0/+3
| |
* | Help: Generic language standard and extension variables documentationRaul Tambre2021-09-281-0/+3
|/ | | | | | Add generic documentation to improve the discoverability of language-specific ones and to make it possible to refer to them generically from other language generic documentation.
* Merge topic 'iar-exe-suffix'Brad King2021-07-201-0/+1
|\ | | | | | | | | | | | | | | 09bc0785ee Help: Document CMAKE_EXECUTABLE_SUFFIX_<LANG> explicitly 05a3bafe65 Compiler/IAR: Avoid clobbering CMAKE_EXECUTABLE_SUFFIX Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !6357
| * Help: Document CMAKE_EXECUTABLE_SUFFIX_<LANG> explicitlyLorenzo Cappelletti2021-07-201-0/+1
| | | | | | | | | | Documentation for `CMAKE_EXECUTABLE_SUFFIX_<LANG>`, useful when cross-compiling, is buried in section `CMAKE_EXECUTABLE_SUFFIX`.
* | Merge topic 'LWYU-externalization'Brad King2021-07-121-0/+2
|\ \ | | | | | | | | | | | | | | | | | | | | | | | | 14e57e9637 LINK_WHAT_YOU_USE feature: externalize configuration 9c5132a586 PGI: Fix "LINKER:" prefix generated separator 8a93de080c cmGeneratorTarget: Add method for LINKER: prefix translation Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !6306
| * | LINK_WHAT_YOU_USE feature: externalize configurationMarc Chevrier2021-07-091-0/+2
| |/ | | | | | | | | | | | | | | Currently, this feature is only supported on ELF platforms. So, the property LINK_WHAT_YOU_USE will be ignored for other plateforms. Moreover, flags and commands are now controled by CMake variables. Fixes: #20174
* | find_package: Add variable to make package REQUIREDEugene Shalygin2021-07-081-0/+1
|/ | | | | | | | | | | | | | Add a `CMAKE_REQUIRE_FIND_PACKAGE_<PackageName>` variable is complement to `CMAKE_DISABLE_FIND_PACKAGE_<PackageName>` with just the opposite behaviour: it turns non-required find_package call into the required one. While optional package dependencies usually result in simple and clean build logic, sometimes people want to be sure those optional dependencies will be found and used. Examples are reproducible builds and build instructions for 3rd parties. People choose to make find_package calls REQUIRED and put them behind an option(). Such workarounds blend build logic with build environment management and do not look elegant.
* HIP: Add language to CMakeRobert Maynard2021-06-071-0/+1
|
* Launchers: Support setting linker launchersBobby D Reynolds2021-05-281-0/+1
| | | | Fixes: #18316
* CPack: Implement new variable CPACK_CUSTOM_INSTALL_VARIABLESNils Gladitz2021-05-231-0/+1
| | | | | | The new variable allows projects to define custom key=value pairs of variables to be set in CPack cmake_install.cmake script invocations. This allows install(SCRIPT|CODE) to be parameterized at runtime.
* Merge topic 'helpctestscript'Brad King2021-05-111-0/+1
|\ | | | | | | | | | | | | 140fe8c3c6 Help: Document CTEST_SCRIPT_DIRECTORY variable Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !6111
| * Help: Document CTEST_SCRIPT_DIRECTORY variableMichael Hirsch2021-05-101-0/+1
| |
* | Help: Document CMAKE_TLS_VERIFY variable explicitlyMichael Hirsch2021-05-041-0/+1
|/ | | | | Previously it was mentioned only in the `file` and `ExternalProject` documentation.
* project: Define variables indicating whether project is top levelfriendlyanon2021-03-261-0/+2
| | | | | | | | | Define `PROJECT_IS_TOP_LEVEL` and `<PROJECT-NAME>_IS_TOP_LEVEL`. The latter is a STATIC cache entry just like other `<PROJECT-NAME>_*` variables so that it is globally scoped. Issue: #20310 Fixes: #21961
* Help: Document CMAKE_ANDROID_NDK_VERSION variableBrad King2021-03-031-0/+1
|
* Merge topic 'unity-anon-ns'Craig Scott2020-12-161-0/+1
|\ | | | | | | | | | | | | 0fe9c40494 Unity Build: Add option for generating per-file unique id Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !4784
| * Unity Build: Add option for generating per-file unique idStephen Kelly2020-12-151-0/+1
| | | | | | | | Fixes: #21477
* | Merge topic 'ispc_control_header_suffixes'Brad King2020-12-151-0/+1
|\ \ | |/ |/| | | | | | | | | c9a50f3556 ISPC: Generated Headers suffix configurable with a better default Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !5597
| * ISPC: Generated Headers suffix configurable with a better defaultRobert Maynard2020-12-141-0/+1
| | | | | | | | | | | | | | | | | | The target property `ISPC_HEADER_SUFFIX` and associated global variable now can control the suffix used when generating the C/C++ interoperability ISPC headers. In addition the default suffix is now "_ispc.h" which matches the common convention that the ISPC compiler team uses and recommends.
| * Merge topic 'apple-silicon-host-arch' into release-3.19Brad King2020-12-111-0/+1
| |\ | | | | | | | | | | | | | | | | | | | | | b7f0327dcd Tests: Cover macOS host architecture selection on Apple Silicon hosts 5f882f6ce5 macOS: Offer control over host architecture on Apple Silicon hosts Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !5589
* | \ Merge topic 'apple-silicon-host-arch'Brad King2020-12-111-0/+1
|\ \ \ | | |/ | |/| | | | | | | | | | | | | | | | b7f0327dcd Tests: Cover macOS host architecture selection on Apple Silicon hosts 5f882f6ce5 macOS: Offer control over host architecture on Apple Silicon hosts Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !5589
| * | macOS: Offer control over host architecture on Apple Silicon hostsBrad King2020-12-101-0/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Since commit b6c60f14b6 (macOS: Default to arm64 architecture on Apple Silicon hosts, 2020-09-28, v3.19.0-rc1~63^2) we use `sysctl` to detect that we are running on Apple Silicon in a way that pierces Rosetta. This always sets `CMAKE_HOST_SYSTEM_PROCESSOR` to be `arm64` on such hosts. However, macOS offers strong support for running processes under an emulated `x86_64` architecture. Teach CMake to select either `arm64` or `x86_64` as the host architecture on Apple Silicon based on the architecture of its own process. When CMake is built as a universal binary, macOS will select whichever slice (architecture) is appropriate under the user's shell, and `CMAKE_HOST_SYSTEM_PROCESSOR` will match. Also offer a `CMAKE_APPLE_SILICON_PROCESSOR` variable and environment variable to provide users with explicit control over the host architecture selection regardless of CMake's own architecture. Finally, if `CMAKE_OSX_ARCHITECTURES` is not set, pass explicit flags to the toolchain to use selected host architecture instead of letting the toolchain pick. Fixes: #21554
* | | Merge branch 'master' into doc-3_19_release-fixesBrad King2020-12-111-0/+4
|\ \ \ | |_|/ |/| |
| * | Makefiles Generators: use compiler for dependencies generationMarc Chevrier2020-11-291-0/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Each source compilation generates a dependencies file. These dependencies files are consolidated in one file per target. This consolidation is done as part of command 'cmake -E cmake_depends` launched before evaluation of makefile dependency graph. The consolidation uses the same approach as `CMake` dependencies management. Fixes: #21321
| * | Merge topic 'android-stl'Brad King2020-11-051-0/+2
| |\ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | 4dca078829 Android: Link c++abi and android_support when necessary 738caa4d48 Android: Add options to control exceptions/rtti Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !5444
| | * | Android: Add options to control exceptions/rttiHaibo Huang2020-11-041-0/+2
| | |/ | | | | | | | | | | | | | | | | | | | | | | | | With the NDK's `android.toolchain.cmake`, the user can control whether exceptions/rtti is enabled using `ANDROID_CPP_FEATURES`: https://android.googlesource.com/platform/ndk/+/43b2de34ef9e3a70573fe51a9e069f985a4be5b9/build/cmake/android.toolchain.cmake#548 Add `CMAKE_ANDROID_RTTI` and `CMAKE_ANDROID_EXCEPTIONS` to support that.
| * | CMakeDetermineCompilerABI: Detect byte order as part of checkBrad King2020-11-041-0/+1
| |/ | | | | | | | | | | | | We already detect `sizeof(void*)`. Detect the byte order as part of the same check. Issue: #21392
* | Help: Re-sort indexes in the manualsCraig Scott2020-12-111-4/+4
|/
* Xcode: Add option to specify build system variantBrad King2020-09-181-0/+1
| | | | | | Extend the `-T <toolset>` option to support a `buildsystem=` field with the Xcode generator. Add a `CMAKE_XCODE_BUILD_SYSTEM` variable to inform project code about the selected build system variant.
* Help: Move CMAKE_XCODE_GENERATE_SCHEME to proper manual sectionBrad King2020-09-141-1/+1
|
* Merge topic 'pch-instantiate-templates'Brad King2020-09-101-0/+1
|\ | | | | | | | | | | | | | | | | | | 8c8f03422e PCH: Template instantiation support Acked-by: Kitware Robot <kwrobot@kitware.com> Acked-by: Raul Tambre <raul@tambre.ee> Acked-by: Cristian Adam <cristian.adam@gmail.com> Tested-by: Raul Tambre <raul@tambre.ee> Merge-request: !5168