summaryrefslogtreecommitdiffstats
path: root/Source/cmPolicies.cxx
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2008-03-13 21:32:13 (GMT)
committerBrad King <brad.king@kitware.com>2008-03-13 21:32:13 (GMT)
commita340fd42b8472cd0379334c26a5b7c9059630917 (patch)
tree3fdd9f6a3685a1a9af955c03addb59163d9c4c5f /Source/cmPolicies.cxx
parent9a83ce6efc10d5d51324f8b425213f18b0325b6e (diff)
downloadCMake-a340fd42b8472cd0379334c26a5b7c9059630917.zip
CMake-a340fd42b8472cd0379334c26a5b7c9059630917.tar.gz
CMake-a340fd42b8472cd0379334c26a5b7c9059630917.tar.bz2
ENH: Clarify documentation of policy CMP0000 and its relationship with cmake_minimum_required.
Diffstat (limited to 'Source/cmPolicies.cxx')
-rw-r--r--Source/cmPolicies.cxx21
1 files changed, 14 insertions, 7 deletions
diff --git a/Source/cmPolicies.cxx b/Source/cmPolicies.cxx
index 872de47..c4b51b5 100644
--- a/Source/cmPolicies.cxx
+++ b/Source/cmPolicies.cxx
@@ -90,15 +90,22 @@ cmPolicies::cmPolicies()
"A policy version number must be specified.",
"CMake requires that projects specify the version of CMake to which "
"they have been written. "
- "This policy has been put in place to help CMake maintain backwards "
- "compatibility with existing projects while allowing it to evolve "
- "more rapidly.\n"
+ "This policy has been put in place to help existing projects build with "
+ "new CMake versions as it evolves. "
"The easiest way to specify a policy version number is to "
- "call the cmake_policy command at the top of your CMakeLists file:\n"
+ "call the cmake_minimum_required command at the top of "
+ "your CMakeLists.txt file:\n"
+ " cmake_minimum_required(VERSION <major>.<minor>)\n"
+ "where \"<major>.<minor>\" is the version of CMake you want to support "
+ "(such as \"2.6\"). "
+ "The command will ensure that at least the given version of CMake is "
+ "running and set the policy version. "
+ "See documentation of cmake_minimum_required for details. "
+ "The cmake_policy command may be used at any time to set the "
+ "policy version:\n"
" cmake_policy(VERSION <major>.<minor>)\n"
- "where <major>.<minor> is the version of CMake you want to support. "
- "The cmake_minimum_required command may also be used; see its "
- "documentation for details.",
+ "This is the recommended way to set the policy version except at "
+ "the very top of a project.",
2,6,0, cmPolicies::WARN
);