summaryrefslogtreecommitdiffstats
path: root/Help
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2015-05-15 18:47:30 (GMT)
committerBrad King <brad.king@kitware.com>2015-05-15 18:48:15 (GMT)
commite5f8ead50b29004847ebc2f7b97bfc0347ccac96 (patch)
tree92199a16ee98f280a579f80f23ff03d32de69a97 /Help
parent2e4ea0c055e01e10c8f459398f943b1b62c5c7bb (diff)
downloadCMake-e5f8ead50b29004847ebc2f7b97bfc0347ccac96.zip
CMake-e5f8ead50b29004847ebc2f7b97bfc0347ccac96.tar.gz
CMake-e5f8ead50b29004847ebc2f7b97bfc0347ccac96.tar.bz2
Help: Document behavior of cmake_minimum_required in a function
Add a note to the cmake_minimum_required documentation about the limits of calling it in a function.
Diffstat (limited to 'Help')
-rw-r--r--Help/command/cmake_minimum_required.rst4
1 files changed, 4 insertions, 0 deletions
diff --git a/Help/command/cmake_minimum_required.rst b/Help/command/cmake_minimum_required.rst
index 92e3001..9865eeb 100644
--- a/Help/command/cmake_minimum_required.rst
+++ b/Help/command/cmake_minimum_required.rst
@@ -35,3 +35,7 @@ with an error instead of just a warning.
:command:`project` command. It is important to establish version
and policy settings before invoking other commands whose behavior
they may affect. See also policy :policy:`CMP0000`.
+
+ Calling ``cmake_minimum_required()`` inside a :command:`function`
+ limits some effects to the function scope when invoked. Such calls
+ should not be made with the intention of having global effects.