kolan
/
CMake
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

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.
This commit is contained in:
Brad King 2013-07-09 08:28:13 -04:00
parent 448a677148
commit e934b1f503
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
Source/cmIncludeCommand.h
View File

@ -55,7 +55,7 @@ public:
*/ */
virtual const char* GetTerseDocumentation() const 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 return
" include(<file|module> [OPTIONAL] [RESULT_VARIABLE <VAR>]\n" " include(<file|module> [OPTIONAL] [RESULT_VARIABLE <VAR>]\n"
" [NO_POLICY_SCOPE])\n" " [NO_POLICY_SCOPE])\n"
"Reads CMake listfile code from the given file. Commands in the file " "Load and run CMake code from the file given. "
"are processed immediately as if they were written in place of the " "Variable reads and writes access the scope of the caller "
"include command. If OPTIONAL is present, then no error " "(dynamic scoping). "
"If OPTIONAL is present, then no error "
"is raised if the file does not exist. If RESULT_VARIABLE is given " "is raised if the file does not exist. If RESULT_VARIABLE is given "
"the variable will be set to the full filename which " "the variable will be set to the full filename which "
"has been included or NOTFOUND if it failed.\n" "has been included or NOTFOUND if it failed.\n"