summaryrefslogtreecommitdiffstats
path: root/Help/manual/cmake-env-variables.7.rst
Commit message (Collapse)AuthorAgeFilesLines
* cmake: Allow CMAKE_INSTALL_PREFIX to be set by environment variableSilvio Traversaro2024-01-301-0/+1
| | | | Fixes: #25023
* add_test: Optionally use a launcher for tests running in-project targetsRalf Habacker2023-12-131-0/+1
| | | | | | | Add a `CMAKE_TEST_LAUNCHER` variable and corresponding `TEST_LAUNCHER` target property. Issue: #23672
* HIP: Add CMAKE_HIP_HOST_COMPILER when compiler is NVCCBrad King2023-09-251-0/+1
| | | | Also add `HIPHOSTCXX` environment variable.
* CrossCompiling: Load CMAKE_CROSSCOMPILING_EMULATOR from environmentMatt McCormick2023-06-131-0/+1
| | | | | | | | | | | Read `CMAKE_CROSSCOMPILING_EMULATOR` from an environment variable of the same name if not specified with `-D` or an initial cache value. Along with existing environment variable settings such as `CMAKE_TOOLCHAIN_FILE`, cross compilation configuration can be more completely set via environment variables. Suggested-by: Henry Schreiner <henryschreineriii@gmail.com>
* Optionally exclude implicit link directories via environmentBrad King2023-05-251-0/+1
| | | | | | | | A misconfigured compiler may pass extraneous implicit link directories to its linker. If they are in `CMAKE_<LANG>_IMPLICIT_LINK_DIRECTORIES`, CMake may generate extra `-L` flags on mixed-language link lines that break linking. Add an environment variable that users can set to work around such misconfiguration of their compilers.
* Help: add documentation for some CMAKE_XXX_PATH env.varsAlex Neundorf2023-05-011-0/+5
| | | | | | | This patch adds basic documentation for the CMAKE_INCLUDE_PATH, CMAKE_LIBRARY_PATH, CMAKE_PROGRAM_PATH, CMAKE_APPBUNDLE_PATH and CMAKE_FRAMEWORK_PATH environment variables and links to the respective cmake variables and vice versa.
* Add CMAKE_MAXIMUM_RECURSION_DEPTH environment variableBrad King2023-03-131-0/+1
| | | | | | | Extend the recursion limit controls added by commit a6982cff0d (cmMakefile: Impose maximum recursion limit, 2018-12-14, v3.14.0-rc1~82^2) with an environment variable that is used if the CMake variable of the same name is not set.
* ctest(1): Add CTEST_NO_TESTS_ACTION env varfriendlyanon2023-01-131-0/+1
| | | | | This environment variable provides a default value for the --no-tests=<action> command line argument.
* cmCurl: Honor OpenSSL certificate environment variablesMaxim Cournoyer2022-09-161-0/+2
| | | | | | | Honor the OpenSSL environment variables used to specify the location of the TLS certificates, as specified in the `curl(1)` man page. Co-authored-by: Ludovic Courtès <ludo@gnu.org>
* ADSP: Add dedicated platform moduleChris Wright2022-04-041-0/+1
|
* color: Add CMAKE_COLOR_DIAGNOSTICS environment variableSemyon Kolton2022-03-081-0/+1
|
* Alternative symlink-creating mode for file(INSTALL ...)Felix Lelchuk2021-08-021-0/+1
| | | | | | | | | | | An new environment variable 'CMAKE_INSTALL_MODE' is introduced, which can be used to ask CMake to create symbolic links instead of copying files during a file(INSTALL ...). The operation is at the file level only, directory trees are still created using actual directories, not links. Signed-off-by: Felix Lelchuk <felix.lelchuk@gmx.de>
* cmake: Allow CMAKE_CONFIGURATION_TYPES to be set by environment variableBrad King2021-06-301-0/+1
| | | | | | | | When no `CMAKE_CONFIGURATION_TYPES` is explicitly specified while creating a new build tree, check for an environment variable of the same name. Issue: #20983
* cmake: Allow CMAKE_BUILD_TYPE to be set by environment variableBrad King2021-06-301-0/+1
| | | | | | | When no `CMAKE_BUILD_TYPE` is explicitly specified while creating a new build tree, check for an environment variable of the same name. Issue: #20983
* HIP: Add language to CMakeRobert Maynard2021-06-071-0/+2
|
* cmake: Allow CMAKE_TOOLCHAIN_FILE to be set by environment variableBrad King2021-06-031-0/+1
| | | | | When no `CMAKE_TOOLCHAIN_FILE` is explicitly specified while creating a new build tree, check for an environment variable of the same name.
* Launchers: Support setting linker launchersBobby D Reynolds2021-05-281-0/+1
| | | | Fixes: #18316
* 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
* | CUDA: Initialize CMAKE_CUDA_ARCHITECTURES using $ENV{CUDAARCHS}Raul Tambre2020-11-301-0/+1
|/ | | | | | | NVCC's default architecture may be newer than the one supported by the machine's GPU. In such cases it's useful to have an environment variable for initializing CMAKE_CUDA_ARCHITECTURES to avoid specifying it for every invocation.
* ISPC: Update help documentation to include ISPCRobert Maynard2020-08-281-0/+2
|
* Merge topic 'objc-env-vars'Brad King2020-05-151-0/+2
|\ | | | | | | | | | | | | | | | | | | 13ea190725 Help: Add 3.17.3 release note for Objective C/C++ compiler selection 16bf978e0c Merge branch 'backport-3.16-objc-env-vars' into objc-env-vars 67b9f55d46 Objective C/C++: Honor CC and CXX env vars to select compiler ab9be6662f Help: Document OBJC and OBJCXX env vars for Objective C/C++ compilers Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !4746
| * Merge branch 'backport-3.16-objc-env-vars' into objc-env-varsBrad King2020-05-141-0/+2
| |\
| | * Help: Document OBJC and OBJCXX env vars for Objective C/C++ compilersBrad King2020-05-141-0/+2
| | |
* | | ccmake: Improve coloring, allow customizationMatthew Woehlke2020-04-241-0/+8
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Change the default color for strings from BLUE (which is nearly illegible on any terminals using the standard color palette which has been around since at least CGA, almost 40 years ago) to CYAN. Add ability to customize the colors via an environment variable (inspired by LS_COLORS and using similar syntax). Fixes: #20596
* | | Help: Document the CMAKE_PREFIX_PATH environment variableJean-Michaël Celerier2020-04-141-0/+7
|/ /
* | launcher: support setting a compiler launcher through the environmentBen Boeckel2019-12-051-0/+1
| | | | | | | | | | | | This makes it much easier to use a launcher for all CMake projects in an environment rather than having to remember to pass the setting to every CMake build.
* | Initialize CMAKE_EXPORT_COMPILE_COMMANDS from envvar of the same nameDaan De Meyer2019-10-181-0/+1
|/ | | | Fixes: #18386
* Merge topic 'default-generator-env'Brad King2019-05-221-0/+4
|\ | | | | | | | | | | | | | | | | d0f0ba0f7a Tests: Add environment generator tests a48ce8f4bf Help: Add documentation for default generator environment variables 083cf7e8a2 cmake: Allow default generator to be set by environment variables Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !3218
| * Help: Add documentation for default generator environment variablesEicke Herbertz2019-05-221-0/+4
| | | | | | | | | | | | | | | | | | | | Documentation for environment variables that control the default generator selection: * CMAKE_GENERATOR * CMAKE_GENERATOR_INSTANCE * CMAKE_GENERATOR_PLATFORM * CMAKE_GENERATOR_TOOLSET
* | Help: add some initial documentation for Swift supportSaleem Abdulrasool2019-05-161-0/+1
|/
* cmake: Add options for verbose output to --build modeFlorian Maushart2019-01-281-0/+2
| | | | | | | | | | | | While we already support `VERBOSE` environment variable and `CMAKE_VERBOSE_MAKEFILE` cached variable, add `-v` and `--verbose` command line options to be able to activate verbose output directly from CMake's build tool mode command line. Also make `msbuild` honor the verbosity setting. `xcodebuild` still doesn't honor the verbosity setting as it will need a policy added and reworking of cmGlobalGenerator and cmsys to support multiple command invocation.
* Help: Provide backreferences.Joachim Wuttke (h)2018-11-081-0/+8
| | | | | Short intro to pages cmake-variables.7 and cmake-env-variables.7, with backlinks to cmake-language.7.
* Help: Add missing docs for the ctest --progress optionCraig Scott2018-10-071-0/+1
| | | | These docs were missing from the changes that introduced the feature in !2240.
* Help: Add explicit <PackageName>_ROOT variable documentationBrad King2018-07-201-0/+1
| | | | | | Add documentation for both the CMake variable and environment variable of this name pattern. Update references to these names to link to their documents. Clarify the pattern used to construct their names.
* cmake: Add options for parallel builds to --build modeFlorian Maushart2018-05-251-0/+1
| | | | | | | While we already support `cmake --build . -- -j`, the options after `--` are specific to the native build tool. Add new options `--parallel [<N>]` and `-j [<N>]` to abstract this and map to the proper option for the native build tool.
* Help: move DESTDIR into a separate pageKyle Edwards2018-04-201-0/+1
|
* Help: Document CMake's environment variablesRobert Maynard2017-09-261-0/+54