summaryrefslogtreecommitdiffstats
path: root/Help/variable
diff options
context:
space:
mode:
authorShane Parris <shane.lee.parris@gmail.com>2018-02-23 13:56:22 (GMT)
committerShane Parris <shane.lee.parris@gmail.com>2018-02-23 16:20:15 (GMT)
commitb6ef4bc329552eb3e4e39156c05f1e2944a88e89 (patch)
tree8b1c99351ab92e94e40930064597f709d2ea5573 /Help/variable
parentebf0a0827992be5cc03e530f9dc06bd1d05c1aa6 (diff)
downloadCMake-b6ef4bc329552eb3e4e39156c05f1e2944a88e89.zip
CMake-b6ef4bc329552eb3e4e39156c05f1e2944a88e89.tar.gz
CMake-b6ef4bc329552eb3e4e39156c05f1e2944a88e89.tar.bz2
Document and extend the CMAKE_SUPPRESS_REGENERATION variable
Fixes: https://gitlab.kitware.com/cmake/cmake/issues/16815
Diffstat (limited to 'Help/variable')
-rw-r--r--Help/variable/CMAKE_SUPPRESS_REGENERATION.rst11
1 files changed, 11 insertions, 0 deletions
diff --git a/Help/variable/CMAKE_SUPPRESS_REGENERATION.rst b/Help/variable/CMAKE_SUPPRESS_REGENERATION.rst
new file mode 100644
index 0000000..ed47e1a
--- /dev/null
+++ b/Help/variable/CMAKE_SUPPRESS_REGENERATION.rst
@@ -0,0 +1,11 @@
+CMAKE_SUPPRESS_REGENERATION
+---------------------------
+
+If CMAKE_SUPPRESS_REGENERATION is ``OFF``, which is default, then CMake adds a
+special target on which all other targets depend that checks the build system
+and optionally re-runs CMake to regenerate the build system when the target
+specification source changes.
+
+If this variable evaluates to ``ON`` at the end of the top-level
+``CMakeLists.txt`` file, CMake will not add the regeneration target to the
+build system or perform any build system checks.