ENH: Clarify FATAL_ERROR option to min-req command

The FATAL_ERROR to cmake_minimum_required is useful for projects that
require 2.6 to convince CMake 2.4 to error out.  This clarifies its
usefulness in the documentation.
This commit is contained in:
Brad King 2009-01-03 15:48:13 -05:00
parent cd7585df22
commit 8df4340909
1 changed files with 4 additions and 3 deletions

View File

@ -77,9 +77,10 @@ public:
"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"
"The FATAL_ERROR option is accepted but ignored. It is left from "
"CMake versions 2.4 and lower in which failure to meet the minimum "
"version was a warning by default.";
"The FATAL_ERROR option is accepted but ignored by CMake 2.6 "
"and higher. "
"One may specify it so CMake versions 2.4 and lower fail with an "
"error instead of just a warning.";
}
cmTypeMacro(cmCMakeMinimumRequired, cmCommand);