From 4a71168735b2e76abdd4d87578ec9587d7e9ebff Mon Sep 17 00:00:00 2001 From: Brad King Date: Mon, 8 Jul 2013 08:20:43 -0400 Subject: [PATCH] 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. --- Source/cmProjectCommand.h | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/Source/cmProjectCommand.h b/Source/cmProjectCommand.h index a53cb3fb8..9547c4c8f 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__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);