ENH: Patch from Alex to add IsDiscouraged method for future use in generating separate documentation for old commands. Also modified documentation of MAKE_DIRECTORY and REMOVE commands to indicate they should not be used.

This commit is contained in:
Brad King
2006-08-31 13:20:12 -04:00
parent 2b33498c03
commit f12742d6cd
15 changed files with 100 additions and 2 deletions
+9 -1
View File
@@ -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);
};