summaryrefslogtreecommitdiff
path: root/Source/cmRemoveCommand.h
diff options
context:
space:
mode:
Diffstat (limited to 'Source/cmRemoveCommand.h')
-rw-r--r--Source/cmRemoveCommand.h10
1 files changed, 9 insertions, 1 deletions
diff --git a/Source/cmRemoveCommand.h b/Source/cmRemoveCommand.h
index a1de0101b9..b7ca5a7a6d 100644
--- a/Source/cmRemoveCommand.h
+++ b/Source/cmRemoveCommand.h
@@ -56,7 +56,7 @@ public:
*/
virtual const char* GetTerseDocumentation()
{
- return "Remove a value from a list in a variable.";
+ return "Old list item removal command. Use the LIST command.";
}
/**
@@ -65,12 +65,20 @@ public:
virtual const char* GetFullDocumentation()
{
return
+ "This command has been superceded by the LIST(REMOVE ...) command. "
+ "It is provided for compatibility with older CMake code.\n"
" REMOVE(VAR VALUE VALUE ...)\n"
"Removes VALUE from the variable VAR. "
"This is typically used to remove entries from a vector "
"(e.g. semicolon separated list). VALUE is expanded.";
}
+ /** This command is only kept for compatibility with older CMake versions. */
+ virtual bool IsDiscouraged()
+ {
+ return true;
+ }
+
cmTypeMacro(cmRemoveCommand, cmCommand);
};