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
+10 -1
View File
@@ -60,7 +60,7 @@ public:
*/
virtual const char* GetTerseDocumentation()
{
return "Create a directory on the file system.";
return "Old directory creation command. Use the FILE command.";
}
/**
@@ -69,12 +69,21 @@ public:
virtual const char* GetFullDocumentation()
{
return
"This command has been superceded by the FILE(MAKE_DIRECTORY ...) "
"command. "
"It is provided for compatibility with older CMake code.\n"
" MAKE_DIRECTORY(directory)\n"
"Creates the specified directory. Full paths should be given. Any "
"parent directories that do not exist will also be created. Use with "
"care.";
}
/** This command is only kept for compatibility with older CMake versions. */
virtual bool IsDiscouraged()
{
return true;
}
cmTypeMacro(cmMakeDirectoryCommand, cmCommand);
};