From a340fd42b8472cd0379334c26a5b7c9059630917 Mon Sep 17 00:00:00 2001 From: Brad King Date: Thu, 13 Mar 2008 17:32:13 -0400 Subject: [PATCH] ENH: Clarify documentation of policy CMP0000 and its relationship with cmake_minimum_required. --- Source/cmCMakeMinimumRequired.h | 4 ++-- Source/cmPolicies.cxx | 21 ++++++++++++++------- 2 files changed, 16 insertions(+), 9 deletions(-) diff --git a/Source/cmCMakeMinimumRequired.h b/Source/cmCMakeMinimumRequired.h index 25e77f3b3..440929409 100644 --- a/Source/cmCMakeMinimumRequired.h +++ b/Source/cmCMakeMinimumRequired.h @@ -69,11 +69,11 @@ public: " cmake_minimum_required(VERSION major[.minor[.patch]]\n" " [FATAL_ERROR])\n" "If the current version of CMake is lower than that required " - "it will stop processing the project and report an error.\n" + "it will stop processing the project and report an error. " "When a version higher than 2.4 is specified the command implicitly " "invokes\n" " cmake_policy(VERSION major[.minor[.patch]])\n" - "which sets the cmake policy version level to the version specified.\n" + "which sets the cmake policy version level to the version specified. " "When version 2.4 or lower is given the command implicitly invokes\n" " cmake_policy(VERSION 2.4)\n" "which enables compatibility features for CMake 2.4 and lower.\n" diff --git a/Source/cmPolicies.cxx b/Source/cmPolicies.cxx index 872de476b..c4b51b561 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 .)\n" + "where \".\" 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 .)\n" - "where . 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 );