summaryrefslogtreecommitdiffstats
path: root/Source/cmRaiseScopeCommand.h
diff options
context:
space:
mode:
authorKen Martin <ken.martin@kitware.com>2008-01-03 16:22:33 (GMT)
committerKen Martin <ken.martin@kitware.com>2008-01-03 16:22:33 (GMT)
commitac4c2f675a5607839a639d2297002c85351bfbe7 (patch)
treec859990e5578df97976d80ec535b8f81c250c1a9 /Source/cmRaiseScopeCommand.h
parentc61a3b6fe9580687458fc9687174a1acce4edf77 (diff)
downloadCMake-ac4c2f675a5607839a639d2297002c85351bfbe7.zip
CMake-ac4c2f675a5607839a639d2297002c85351bfbe7.tar.gz
CMake-ac4c2f675a5607839a639d2297002c85351bfbe7.tar.bz2
ENH: change raise_scope signature to be safer for returned varuables
Diffstat (limited to 'Source/cmRaiseScopeCommand.h')
-rw-r--r--Source/cmRaiseScopeCommand.h9
1 files changed, 5 insertions, 4 deletions
diff --git a/Source/cmRaiseScopeCommand.h b/Source/cmRaiseScopeCommand.h
index 51d4f1f..0ff2e4e 100644
--- a/Source/cmRaiseScopeCommand.h
+++ b/Source/cmRaiseScopeCommand.h
@@ -61,12 +61,13 @@ public:
virtual const char* GetFullDocumentation()
{
return
- " raise_scope(VAR VAR2 VAR...)\n"
- "Pushes the current state of a variable into the scope above the "
+ " raise_scope(VAR [VALUE])\n"
+ "Sets the value of a variable in the scope above the "
"current scope. Each new directory or function creates a new scope. "
- "This command will push the current state of a variable into the "
+ "This command will set the value of a variable into the "
"parent directory or calling function (whichever is applicable to "
- "the case at hand)";
+ "the case at hand) If VALUE is not specified then the variable is "
+ "removed from the parent scope.";
}
/**