From e934b1f50359ae229015ad5453fee4df89ece055 Mon Sep 17 00:00:00 2001 From: Brad King Date: Tue, 9 Jul 2013 08:28:13 -0400 Subject: [PATCH] include: Clarify variable access scope for included file The wording "Commands in the file are processed immediately as if they were written in place of the include command" sounds as if some kind of macro replacement is performed. This is not accurate. Update the wording to describe behavior of the included code in terms of the variable access scope. --- Source/cmIncludeCommand.h | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/Source/cmIncludeCommand.h b/Source/cmIncludeCommand.h index c46c02d71..d97b7c3f5 100644 --- a/Source/cmIncludeCommand.h +++ b/Source/cmIncludeCommand.h @@ -55,7 +55,7 @@ public: */ virtual const char* GetTerseDocumentation() const { - return "Read CMake listfile code from the given file."; + return "Load and run CMake code from a file or module."; } /** @@ -66,9 +66,10 @@ public: return " include( [OPTIONAL] [RESULT_VARIABLE ]\n" " [NO_POLICY_SCOPE])\n" - "Reads CMake listfile code from the given file. Commands in the file " - "are processed immediately as if they were written in place of the " - "include command. If OPTIONAL is present, then no error " + "Load and run CMake code from the file given. " + "Variable reads and writes access the scope of the caller " + "(dynamic scoping). " + "If OPTIONAL is present, then no error " "is raised if the file does not exist. If RESULT_VARIABLE is given " "the variable will be set to the full filename which " "has been included or NOTFOUND if it failed.\n"