summaryrefslogtreecommitdiffstats
path: root/Help
diff options
context:
space:
mode:
authorCraig Scott <craig.scott@crascit.com>2020-12-11 00:11:29 (GMT)
committerCraig Scott <craig.scott@crascit.com>2020-12-11 00:19:04 (GMT)
commit08164823027f16b0839e705103226a1a7e33cb9f (patch)
tree8dc7c06146104d0d0dc47fe7364a7563549d91f0 /Help
parent0334a3c68f1064a7bb1f682d81f03e06f3608893 (diff)
downloadCMake-08164823027f16b0839e705103226a1a7e33cb9f.zip
CMake-08164823027f16b0839e705103226a1a7e33cb9f.tar.gz
CMake-08164823027f16b0839e705103226a1a7e33cb9f.tar.bz2
Help: xref variable that cmake_minimum_required() sets
The CMAKE_MINIMUM_REQUIRED_VERSION has long been set by the cmake_minimum_required() command, but the command docs never mentioned this. Only the variable's own docs stated this but the variable isn't very discoverable without it being mentioned in the command's docs as well.
Diffstat (limited to 'Help')
-rw-r--r--Help/command/cmake_minimum_required.rst3
1 files changed, 3 insertions, 0 deletions
diff --git a/Help/command/cmake_minimum_required.rst b/Help/command/cmake_minimum_required.rst
index e6ebcf0..f3326b8 100644
--- a/Help/command/cmake_minimum_required.rst
+++ b/Help/command/cmake_minimum_required.rst
@@ -22,6 +22,9 @@ dots will be seen as version component separators, resulting in the
``...<max>`` part being ignored and preserving the pre-3.12 behavior
of basing policies on ``<min>``.
+This command will set the value of the
+:variable:`CMAKE_MINIMUM_REQUIRED_VERSION` variable to ``<min>``.
+
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.