project: Document top-level CMakeLists.txt requirement

CMake requires the top-level CMakeLists.txt to contain a direct call to
the project() command and will insert one if there is not.  Document
this requirement since some authors have tried to use include() to load
a file calling the project command.
This commit is contained in:
Brad King 2013-07-08 08:20:43 -04:00
parent 5dd8c01429
commit 4a71168735
1 changed files with 7 additions and 1 deletions

View File

@ -71,7 +71,13 @@ public:
"language \"NONE\" all checks for any language can be disabled. " "language \"NONE\" all checks for any language can be disabled. "
"If a variable exists called CMAKE_PROJECT_<projectName>_INCLUDE, " "If a variable exists called CMAKE_PROJECT_<projectName>_INCLUDE, "
"the file pointed to by that variable will be included as the last step " "the file pointed to by that variable will be included as the last step "
"of the project command."; "of the project command."
"\n"
"The top-level CMakeLists.txt file for a project must contain a "
"literal, direct call to the project() command; loading one through "
"the include() command is not sufficient. "
"If no such call exists CMake will implicitly add one to the top that "
"enables the default languages (C and CXX).";
} }
cmTypeMacro(cmProjectCommand, cmCommand); cmTypeMacro(cmProjectCommand, cmCommand);