diff options
author | Brad King <brad.king@kitware.com> | 2013-07-15 13:31:10 (GMT) |
---|---|---|
committer | CMake Topic Stage <kwrobot@kitware.com> | 2013-07-15 13:31:10 (GMT) |
commit | 37ba3d4a6afb13b5544306225637547ac2dbb32a (patch) | |
tree | ff054d5231cd3750e18da5bc46ff81ffbf3e919d /Source | |
parent | 88f4ec0dd5a1e181ca3dc35992755930599f2e3f (diff) | |
parent | e934b1f50359ae229015ad5453fee4df89ece055 (diff) | |
download | CMake-37ba3d4a6afb13b5544306225637547ac2dbb32a.zip CMake-37ba3d4a6afb13b5544306225637547ac2dbb32a.tar.gz CMake-37ba3d4a6afb13b5544306225637547ac2dbb32a.tar.bz2 |
Merge topic 'doc-include-clarify'
e934b1f include: Clarify variable access scope for included file
Diffstat (limited to 'Source')
-rw-r--r-- | Source/cmIncludeCommand.h | 9 |
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" |