summaryrefslogtreecommitdiffstats
path: root/Help/command/cmake_minimum_required.rst
diff options
context:
space:
mode:
Diffstat (limited to 'Help/command/cmake_minimum_required.rst')
-rw-r--r--Help/command/cmake_minimum_required.rst30
1 files changed, 30 insertions, 0 deletions
diff --git a/Help/command/cmake_minimum_required.rst b/Help/command/cmake_minimum_required.rst
new file mode 100644
index 0000000..1bdffa4
--- /dev/null
+++ b/Help/command/cmake_minimum_required.rst
@@ -0,0 +1,30 @@
+cmake_minimum_required
+----------------------
+
+Set the minimum required version of cmake for a project.
+
+::
+
+ cmake_minimum_required(VERSION major[.minor[.patch[.tweak]]]
+ [FATAL_ERROR])
+
+If the current version of CMake is lower than that required it will
+stop processing the project and report an error. When a version
+higher than 2.4 is specified the command implicitly invokes
+
+::
+
+ cmake_policy(VERSION major[.minor[.patch[.tweak]]])
+
+which sets the cmake policy version level to the version specified.
+When version 2.4 or lower is given the command implicitly invokes
+
+::
+
+ cmake_policy(VERSION 2.4)
+
+which enables compatibility features for CMake 2.4 and lower.
+
+The FATAL_ERROR option is accepted but ignored by CMake 2.6 and
+higher. It should be specified so CMake versions 2.4 and lower fail
+with an error instead of just a warning.