summaryrefslogtreecommitdiffstats
path: root/Help/variable/CMAKE_GENERATOR.rst
diff options
context:
space:
mode:
authorEicke Herbertz <wolletd@posteo.de>2019-04-11 22:50:33 (GMT)
committerBrad King <brad.king@kitware.com>2019-05-22 11:40:49 (GMT)
commita48ce8f4bf0677e9e8d054892836e8a980ffa435 (patch)
treedc287ce52f3e6b425d25b789f2951d37a2c4dbd3 /Help/variable/CMAKE_GENERATOR.rst
parent083cf7e8a2515d9f838f3edbb2724fd3b17d83cd (diff)
downloadCMake-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/variable/CMAKE_GENERATOR.rst')
-rw-r--r--Help/variable/CMAKE_GENERATOR.rst5
1 files changed, 5 insertions, 0 deletions
diff --git a/Help/variable/CMAKE_GENERATOR.rst b/Help/variable/CMAKE_GENERATOR.rst
index cce04c1..ec52cd4 100644
--- a/Help/variable/CMAKE_GENERATOR.rst
+++ b/Help/variable/CMAKE_GENERATOR.rst
@@ -5,3 +5,8 @@ The generator used to build the project. See :manual:`cmake-generators(7)`.
The name of the generator that is being used to generate the build
files. (e.g. ``Unix Makefiles``, ``Ninja``, etc.)
+
+The value of this variable should never be modified by project code.
+A generator may be selected via the :manual:`cmake(1)` ``-G`` option,
+interactively in :manual:`cmake-gui(1)`, or via the :envvar:`CMAKE_GENERATOR`
+environment variable.