ENH: Patch from Alex to make deprecated command documentation more consistent.

11 files changed, 16 insertions, 22 deletions

diff --git a/Source/cmExecProgramCommand.h b/Source/cmExecProgramCommand.h
index 4836337..8518610 100644
--- a/Source/cmExecProgramCommand.h
+++ b/Source/cmExecProgramCommand.h
@@ -60,8 +60,7 @@ public:
   virtual const char* GetTerseDocumentation() 
     {
     return 
-      "Run and executable program during the processing of the CMakeList.txt"
-      " file.";
+      "Deprecated.  Use the EXECUTE_PROCESS() command instead.";
     }
   
   /**
@@ -70,6 +69,8 @@ public:
   virtual const char* GetFullDocumentation()
     {
     return
+      "Run and executable program during the processing of the CMakeList.txt"
+      " file.\n"
       "  EXEC_PROGRAM(Executable [directory in which to run]\n"
       "               [ARGS <arguments to executable>]\n"
       "               [OUTPUT_VARIABLE <var>]\n"
@@ -83,8 +84,6 @@ public:
       "To capture the return value of the execution, provide a RETURN_VALUE. "
       "If OUTPUT_VARIABLE is specified, then no output will go to the "
       "stdout/stderr of the console running cmake.\n"
-      "The EXECUTE_PROCESS command is a newer more powerful version of "
-      "EXEC_PROGRAM, but the old command has been kept for compatibility."
       ;
     }
   
diff --git a/Source/cmInstallFilesCommand.h b/Source/cmInstallFilesCommand.h
index 51a87ef..ec1ad9d 100644
--- a/Source/cmInstallFilesCommand.h
+++ b/Source/cmInstallFilesCommand.h
@@ -52,7 +52,7 @@ public:
    */
   virtual const char* GetTerseDocumentation() 
     {
-    return "Old installation command.  Use the INSTALL command.";
+    return "Deprecated.  Use the INSTALL(FILES ) command instead.";
     }
   
   /**
diff --git a/Source/cmInstallProgramsCommand.h b/Source/cmInstallProgramsCommand.h
index ef63c27..3fe2bf3 100644
--- a/Source/cmInstallProgramsCommand.h
+++ b/Source/cmInstallProgramsCommand.h
@@ -52,7 +52,7 @@ public:
    */
   virtual const char* GetTerseDocumentation() 
     {
-    return "Old installation command.  Use the INSTALL command.";
+    return "Deprecated. Use the INSTALL(PROGRAMS ) command instead.";
     }
   
   /**
diff --git a/Source/cmInstallTargetsCommand.h b/Source/cmInstallTargetsCommand.h
index 0ea9035..59d68f3 100644
--- a/Source/cmInstallTargetsCommand.h
+++ b/Source/cmInstallTargetsCommand.h
@@ -53,7 +53,7 @@ public:
    */
   virtual const char* GetTerseDocumentation() 
     {
-    return "Old installation command.  Use the INSTALL command.";
+    return "Deprecated. Use the INSTALL(TARGETS )  command instead.";
     }
   
   /**
diff --git a/Source/cmLinkLibrariesCommand.h b/Source/cmLinkLibrariesCommand.h
index cd9a34f..9e860e9 100644
--- a/Source/cmLinkLibrariesCommand.h
+++ b/Source/cmLinkLibrariesCommand.h
@@ -53,7 +53,7 @@ public:
    */
   virtual const char* GetTerseDocumentation() 
     {
-    return "Link libraries to all targets added later.";
+    return "Deprecated. Use the TARGET_LINK_LIBRARIES() command instead.";
     }
   
   /**
@@ -62,10 +62,8 @@ public:
   virtual const char* GetFullDocumentation()
     {
     return
+      "Link libraries to all targets added later.\n"
       "  LINK_LIBRARIES(library1 <debug | optimized> library2 ...)\n"
-      "This is an old CMake command for linking libraries.  Use "
-      "TARGET_LINK_LIBRARIES unless you have a good reason for every target "
-      "to link to the same set of libraries.\n"
       "Specify a list of libraries to be linked into "
       "any following targets (typically added with the ADD_EXECUTABLE "
       "or ADD_LIBRARY calls).  This command is passed "
diff --git a/Source/cmMakeDirectoryCommand.h b/Source/cmMakeDirectoryCommand.h
index 951b3c0..f43c943 100644
--- a/Source/cmMakeDirectoryCommand.h
+++ b/Source/cmMakeDirectoryCommand.h
@@ -60,7 +60,7 @@ public:
    */
   virtual const char* GetTerseDocumentation() 
     {
-    return "Old directory creation command.  Use the FILE command.";
+    return "Deprecated. Use the FILE(MAKE_DIRECTORY ) command instead.";
     }
   
   /**
@@ -69,9 +69,6 @@ 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 "
diff --git a/Source/cmRemoveCommand.h b/Source/cmRemoveCommand.h
index 7062770..04bf314 100644
--- a/Source/cmRemoveCommand.h
+++ b/Source/cmRemoveCommand.h
@@ -56,7 +56,7 @@ public:
    */
   virtual const char* GetTerseDocumentation() 
     {
-    return "Old list item removal command.  Use the LIST command.";
+    return "Deprecated. Use the LIST(REMOVE_ITEM ) command instead.";
     }
   
   /**
@@ -65,8 +65,6 @@ 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 "
diff --git a/Source/cmSubdirCommand.h b/Source/cmSubdirCommand.h
index fe7c392..c7cf1f2 100644
--- a/Source/cmSubdirCommand.h
+++ b/Source/cmSubdirCommand.h
@@ -53,7 +53,7 @@ public:
    */
   virtual const char* GetTerseDocumentation() 
     {
-    return "Add a list of subdirectories to the build.";
+    return "Deprecated. Use the ADD_SUBDIRECTORY() command instead.";
     }
   
   /**
@@ -62,6 +62,7 @@ public:
   virtual const char* GetFullDocumentation()
     {
     return
+      "Add a list of subdirectories to the build.\n";
       "  SUBDIRS(dir1 dir2 ..."
       "[EXCLUDE_FROM_ALL exclude_dir1 exclude_dir2 ...] [PREORDER] )\n"
       "Add a list of subdirectories to the build. The ADD_SUBDIRECTORY "
diff --git a/Source/cmSubdirDependsCommand.h b/Source/cmSubdirDependsCommand.h
index 6e1986d..4412f4a 100644
--- a/Source/cmSubdirDependsCommand.h
+++ b/Source/cmSubdirDependsCommand.h
@@ -53,7 +53,7 @@ public:
    */
   virtual const char* GetTerseDocumentation() 
     {
-    return "Legacy command.  Does nothing.";
+    return "Deprecated.  Does nothing.";
     }
   
   /**
diff --git a/Source/cmVariableRequiresCommand.h b/Source/cmVariableRequiresCommand.h
index 28ef7bd..7de3933 100644
--- a/Source/cmVariableRequiresCommand.h
+++ b/Source/cmVariableRequiresCommand.h
@@ -50,7 +50,7 @@ public:
    */
   virtual const char* GetTerseDocumentation() 
     {
-    return "Assert satisfaction of an option's required variables.";
+    return "Deprecated. Use the IF() command instead.";
     }
   
   /**
@@ -59,6 +59,7 @@ public:
   virtual const char* GetFullDocumentation()
     {
     return
+      "Assert satisfaction of an option's required variables.\n"
       "  VARIABLE_REQUIRES(TEST_VARIABLE RESULT_VARIABLE\n"
       "                    REQUIRED_VARIABLE1\n"
       "                    REQUIRED_VARIABLE2 ...)\n"
diff --git a/Source/cmWriteFileCommand.h b/Source/cmWriteFileCommand.h
index 7d5c2bd..7ebd5bd 100644
--- a/Source/cmWriteFileCommand.h
+++ b/Source/cmWriteFileCommand.h
@@ -55,7 +55,7 @@ public:
    */
   virtual const char* GetTerseDocumentation() 
     {
-    return "Write a message to a file.";
+    return "Deprecated. Use the FILE(WRITE ) command instead.";
     }
   
   /**