summaryrefslogtreecommitdiff
path: root/Help/envvar
Commit message (Collapse)AuthorAgeFilesLines
* Add CMAKE_MAXIMUM_RECURSION_DEPTH environment variableBrad King2023-03-131-0/+10
| | | | | | | 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.
* find_package: Use <PACKAGENAME>_ROOT variables as search prefixesBrad King2023-02-231-0/+14
| | | | | | | | | Extend commit eb35d8884b (find_package: Use PackageName_ROOT variables as search prefixes, 2018-03-15, v3.12.0-rc1~349^2) to also check upper-case `<PACKAGENAME>_ROOT` variables. Add policy `CMP0144` to enable the behavior in a compatible way. Fixes: #24403
* Help: Clarify that <PackageName>_ROOT variable names are case-preservedBrad King2023-02-081-4/+4
| | | | | The name comes from the case-preserved first argument to `find_package`.
* ctest(1): Add CTEST_NO_TESTS_ACTION env varfriendlyanon2023-01-131-0/+14
| | | | | This environment variable provides a default value for the --no-tests=<action> command line argument.
* ASM_MARMASM: Add support for Microsoft ARM assembler languageIlia K2022-11-092-2/+9
| | | | | | https://learn.microsoft.com/en-us/cpp/assembler/arm/arm-assembler-reference Fixes: #23999
* Help: Clarify how language-specific flag environment values are usedBrad King2022-10-1810-56/+57
| | | | | | | | | Previous the wording could be interpreted to mean that the environment variables like `CXXFLAGS` are used exclusively to initialize the corresponding cache entries like `CMAKE_CXX_FLAGS`. State clearly that the value will be used in combination with builtin defaults. Issue: #23956
* Help: Disambiguate cmake(1) program modes in Sphinx option referencesBrad King2022-10-051-1/+1
| | | | | | Define the entry point to each mode as an option for the `cmake` program, but reference the options for that mode as part of stand-in `cmake-<mode>` programs.
* cmCurl: Honor OpenSSL certificate environment variablesMaxim Cournoyer2022-09-162-0/+18
| | | | | | | 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>
* Help: Replace a bunch of more ``--option`` to `:option:` roleAlex Turbov2022-08-042-4/+5
|
* Help: Replace mentions of ``-T`` and ``-A`` options with roleAlex Turbov2022-08-042-2/+2
|
* Help: Replace mentions of ``-G`` option with :option:`-G` roleAlex Turbov2022-08-041-3/+3
|
* Help: Update Sphinx versionadded directives for 3.24 releaseBrad King2022-06-081-0/+2
| | | | | | Run the script: Utilities/Sphinx/update_versions.py --since v3.23.0 --overwrite
* ADSP: Add dedicated platform moduleChris Wright2022-04-041-0/+8
|
* color: Add CMAKE_COLOR_DIAGNOSTICS environment variableSemyon Kolton2022-03-081-0/+9
|
* Help: Clarify roles of DESTDIR and CMAKE_INSTALL_PREFIXBrad King2022-02-041-10/+19
|
* Help: Correct CUDAHOSTCXX and CUDAARCHS as having higher precedenceRaul Tambre2022-01-152-5/+3
| | | | | | | | | | | | | | | | | | | | | For CUDAHOSTCXX the behaviour seems to have been like this since the introduction of it in commit 9cf5b98d ("CUDA: Prefer environment variables CUDACXX and CUDAHOSTCXX.", 2016-11-08) and is likely unintentional judging by the wording of the commit. The documentation mistake seems to be a copy-paste error from when all the environment variables were documented in commit e6b77c5f ("Help: Document CMake's environment variables", 2017-09-01). Describe this explicitly as it is unlike all other similar environment variables. For CUDAARCHS we got it wrong from the get-go in commit c4ae9384 ("CUDA: Initialize CMAKE_CUDA_ARCHITECTURES using $ENV{CUDAARCHS}", 2020-11-24). Correcting either to follow the more standard precedence behaviour will require a policy. Fixes #23081.
* Help: Clarify CMAKE_INSTALL_MODE documentationFelix Lelchuk2021-11-241-10/+70
| | | | Fixes: #22869 Co-Authored-By: Craig Scott <craig.scott@crascit.com>
* Help: Use definition list for allowed values of CMAKE_INSTALL_MODECraig Scott2021-11-241-8/+27
| | | | Clean up the wording as well for improved consistency and clarity.
* Alternative symlink-creating mode for file(INSTALL ...)Felix Lelchuk2021-08-021-0/+37
| | | | | | | | | | | 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/+11
| | | | | | | | 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/+10
| | | | | | | 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-072-0/+28
|
* cmake: Allow CMAKE_TOOLCHAIN_FILE to be set by environment variableBrad King2021-06-031-0/+12
| | | | | 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/+13
| | | | Fixes: #18316
* CUDA: Add CMAKE_CUDA_HOST_COMPILER support on Windows non-VS generatorsunknown2021-04-221-0/+4
|
* Merge topic 'apple-silicon-host-arch'Brad King2020-12-111-0/+13
|\ | | | | | | | | | | | | | | 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/+13
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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
* | Help: Add `.. versionadded` directives to module docsNikita Nemkin2020-12-021-2/+5
| | | | | | | | Issue: #19715
* | CUDA: Initialize CMAKE_CUDA_ARCHITECTURES using $ENV{CUDAARCHS}Raul Tambre2020-11-301-0/+13
|/ | | | | | | 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.
* Help: Fix `.. versionadded` directives in environment variable docsNikita Nemkin2020-11-1127-49/+5
| | | | | | | | Many environment variables were documented late and got assigned wrong versions by the script. (The whole Help/envvar section was only added in 3.10). Issue: #19715
* ISPC: Update help documentation to include ISPCRobert Maynard2020-08-282-0/+28
|
* Toolchain: Update documentation for initial compiler flagsFred Baksik2020-08-038-1/+57
|
* Help: Add Sphinx 'versionadded' directives to each top-level documentKitware Robot2020-07-0641-0/+82
| | | | | | | Run the `Utilities/Sphinx/update_versions.py` script to add initial markup to every top-level document and find module. Issue: #19715
* Help: Clarify how env vars and ..._INIT variables interactCraig Scott2020-05-247-0/+14
| | | Fixes: #20358
* Merge topic 'objc-env-vars'Brad King2020-05-152-0/+28
|\ | | | | | | | | | | | | | | | | | | 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-142-0/+28
| |\
| | * Objective C/C++: Honor CC and CXX env vars to select compilerBrad King2020-05-142-0/+6
| | | | | | | | | | | | | | | | | | | | | If the `OBJC` or `OBJCXX` environment variable is not set to specify an Objective C or C++ compiler, check `CC` or `CXX` too. Fixes: #20703
| | * Help: Document OBJC and OBJCXX env vars for Objective C/C++ compilersBrad King2020-05-142-0/+22
| | |
* | | ccmake: Improve coloring, allow customizationMatthew Woehlke2020-04-241-0/+34
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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/+17
|/ /
* | launcher: support setting a compiler launcher through the environmentBen Boeckel2019-12-051-0/+10
| | | | | | | | | | | | 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/+9
|/ | | | Fixes: #18386
* Merge topic 'default-generator-env'Brad King2019-05-224-0/+39
|\ | | | | | | | | | | | | | | | | 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-224-0/+39
| | | | | | | | | | | | | | | | | | | | 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/+11
|/
* Modules: Update documentation formattingBartosz Kosiorek2019-04-082-4/+4
|
* Help: Improve formatting of Help documentationBartosz Kosiorek2019-04-087-12/+14
|
* cmake: Add options for verbose output to --build modeFlorian Maushart2019-01-282-0/+18
| | | | | | | | | | | | 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: Describe environment variables as such.Joachim Wuttke (l)2018-11-1329-0/+59
| | | | | | | In each environment variable doc page, insert an opening paragraph (ENV_VAR.txt) to say that this is an environment variable, and provide a link to the cmake-language section on environment variables.
* Help: Add missing docs for the ctest --progress optionCraig Scott2018-10-071-0/+14
| | | | These docs were missing from the changes that introduced the feature in !2240.
View Lorry Controller Status