diff options
| author | Eicke Herbertz <wolletd@posteo.de> | 2019-04-11 22:50:33 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2019-05-22 11:40:49 (GMT) |
| commit | a48ce8f4bf0677e9e8d054892836e8a980ffa435 (patch) | |
| tree | dc287ce52f3e6b425d25b789f2951d37a2c4dbd3 /Help/envvar | |
| parent | 083cf7e8a2515d9f838f3edbb2724fd3b17d83cd (diff) | |
| download | CMake-a48ce8f4bf0677e9e8d054892836e8a980ffa435.zip CMake-a48ce8f4bf0677e9e8d054892836e8a980ffa435.tar.gz CMake-a48ce8f4bf0677e9e8d054892836e8a980ffa435.tar.bz2 | |
Help: Add documentation for default generator environment variables
Documentation for environment variables that control the default
generator selection:
* CMAKE_GENERATOR
* CMAKE_GENERATOR_INSTANCE
* CMAKE_GENERATOR_PLATFORM
* CMAKE_GENERATOR_TOOLSET
Diffstat (limited to 'Help/envvar')
| -rw-r--r-- | Help/envvar/CMAKE_GENERATOR.rst | 16 | ||||
| -rw-r--r-- | Help/envvar/CMAKE_GENERATOR_INSTANCE.rst | 7 | ||||
| -rw-r--r-- | Help/envvar/CMAKE_GENERATOR_PLATFORM.rst | 8 | ||||
| -rw-r--r-- | Help/envvar/CMAKE_GENERATOR_TOOLSET.rst | 8 |
4 files changed, 39 insertions, 0 deletions
diff --git a/Help/envvar/CMAKE_GENERATOR.rst b/Help/envvar/CMAKE_GENERATOR.rst new file mode 100644 index 0000000..f2d055f --- /dev/null +++ b/Help/envvar/CMAKE_GENERATOR.rst @@ -0,0 +1,16 @@ +CMAKE_GENERATOR +--------------- + +.. include:: ENV_VAR.txt + +Specifies the CMake default generator to use when no generator is supplied +with ``-G``. If the provided value doesn't name a generator known by CMake, +the internal default is used. Either way the resulting generator selection +is stored in the :variable:`CMAKE_GENERATOR` variable. + +Some generators may be additionally configured using the environment +variables: + +* :envvar:`CMAKE_GENERATOR_PLATFORM` +* :envvar:`CMAKE_GENERATOR_TOOLSET` +* :envvar:`CMAKE_GENERATOR_INSTANCE` diff --git a/Help/envvar/CMAKE_GENERATOR_INSTANCE.rst b/Help/envvar/CMAKE_GENERATOR_INSTANCE.rst new file mode 100644 index 0000000..1654fa1 --- /dev/null +++ b/Help/envvar/CMAKE_GENERATOR_INSTANCE.rst @@ -0,0 +1,7 @@ +CMAKE_GENERATOR_INSTANCE +------------------------ + +.. include:: ENV_VAR.txt + +Default value for :variable:`CMAKE_GENERATOR_INSTANCE` if no Cache entry is +present. This value is only applied if :envvar:`CMAKE_GENERATOR` is set. diff --git a/Help/envvar/CMAKE_GENERATOR_PLATFORM.rst b/Help/envvar/CMAKE_GENERATOR_PLATFORM.rst new file mode 100644 index 0000000..917b30b --- /dev/null +++ b/Help/envvar/CMAKE_GENERATOR_PLATFORM.rst @@ -0,0 +1,8 @@ +CMAKE_GENERATOR_PLATFORM +------------------------ + +.. include:: ENV_VAR.txt + +Default value for :variable:`CMAKE_GENERATOR_PLATFORM` if no Cache entry +is present and no value is specified by :manual:`cmake(1)` ``-A`` option. +This value is only applied if :envvar:`CMAKE_GENERATOR` is set. diff --git a/Help/envvar/CMAKE_GENERATOR_TOOLSET.rst b/Help/envvar/CMAKE_GENERATOR_TOOLSET.rst new file mode 100644 index 0000000..7ac3856 --- /dev/null +++ b/Help/envvar/CMAKE_GENERATOR_TOOLSET.rst @@ -0,0 +1,8 @@ +CMAKE_GENERATOR_TOOLSET +----------------------- + +.. include:: ENV_VAR.txt + +Default value for :variable:`CMAKE_GENERATOR_TOOLSET` if no Cache entry +is present and no value is specified by :manual:`cmake(1)` ``-T`` option. +This value is only applied if :envvar:`CMAKE_GENERATOR` is set. |