summaryrefslogtreecommitdiff
path: root/Source/cmProjectCommand.h
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2013-07-08 08:20:43 -0400
committerBrad King <brad.king@kitware.com>2013-07-08 08:22:30 -0400
commit4a71168735b2e76abdd4d87578ec9587d7e9ebff (patch)
tree5a853e8c1f6119e97644625cf85dcb1f84424fc3 /Source/cmProjectCommand.h
parent5dd8c01429da90a7417b72f17e784cc98f70f57c (diff)
downloadcmake-4a71168735b2e76abdd4d87578ec9587d7e9ebff.tar.gz
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.
Diffstat (limited to 'Source/cmProjectCommand.h')
-rw-r--r--Source/cmProjectCommand.h8
1 files changed, 7 insertions, 1 deletions
diff --git a/Source/cmProjectCommand.h b/Source/cmProjectCommand.h
index a53cb3fb82..9547c4c8f1 100644
--- a/Source/cmProjectCommand.h
+++ b/Source/cmProjectCommand.h
@@ -71,7 +71,13 @@ public:
"language \"NONE\" all checks for any language can be disabled. "
"If a variable exists called CMAKE_PROJECT_<projectName>_INCLUDE, "
"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);