summaryrefslogtreecommitdiffstats
path: root/Source/cmIncludeCommand.h
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2013-07-09 12:28:13 (GMT)
committerBrad King <brad.king@kitware.com>2013-07-09 12:31:23 (GMT)
commite934b1f50359ae229015ad5453fee4df89ece055 (patch)
tree787ff497b656ac1342ccbad5c5362fc654421b71 /Source/cmIncludeCommand.h
parent448a67714825a6d3018a6974153de6771080a8e6 (diff)
downloadCMake-e934b1f50359ae229015ad5453fee4df89ece055.zip
CMake-e934b1f50359ae229015ad5453fee4df89ece055.tar.gz
CMake-e934b1f50359ae229015ad5453fee4df89ece055.tar.bz2
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.
Diffstat (limited to 'Source/cmIncludeCommand.h')
-rw-r--r--Source/cmIncludeCommand.h9
1 files changed, 5 insertions, 4 deletions
diff --git a/Source/cmIncludeCommand.h b/Source/cmIncludeCommand.h
index c46c02d..d97b7c3 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(<file|module> [OPTIONAL] [RESULT_VARIABLE <VAR>]\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"