[cmake-commits] king committed cmExecProgramCommand.h 1.19 1.20
cmInstallFilesCommand.h 1.18 1.19 cmInstallProgramsCommand.h
1.16 1.17 cmInstallTargetsCommand.h 1.13 1.14
cmLinkLibrariesCommand.h 1.17 1.18 cmMakeDirectoryCommand.h
1.10 1.11 cmRemoveCommand.h 1.8 1.9 cmSubdirCommand.h 1.17 1.18
cmSubdirDependsCommand.h 1.9 1.10 cmVariableRequiresCommand.h
1.12 1.13 cmWriteFileCommand.h 1.9 1.10
cmake-commits at cmake.org
cmake-commits at cmake.org
Wed Jan 24 13:45:45 EST 2007
Update of /cvsroot/CMake/CMake/Source
In directory public:/mounts/ram/cvs-serv11165
Modified Files:
cmExecProgramCommand.h cmInstallFilesCommand.h
cmInstallProgramsCommand.h cmInstallTargetsCommand.h
cmLinkLibrariesCommand.h cmMakeDirectoryCommand.h
cmRemoveCommand.h cmSubdirCommand.h cmSubdirDependsCommand.h
cmVariableRequiresCommand.h cmWriteFileCommand.h
Log Message:
ENH: Patch from Alex to make deprecated command documentation more consistent.
Index: cmInstallProgramsCommand.h
===================================================================
RCS file: /cvsroot/CMake/CMake/Source/cmInstallProgramsCommand.h,v
retrieving revision 1.16
retrieving revision 1.17
diff -u -d -r1.16 -r1.17
--- cmInstallProgramsCommand.h 1 Sep 2006 13:51:28 -0000 1.16
+++ cmInstallProgramsCommand.h 24 Jan 2007 18:45:42 -0000 1.17
@@ -52,7 +52,7 @@
*/
virtual const char* GetTerseDocumentation()
{
- return "Old installation command. Use the INSTALL command.";
+ return "Deprecated. Use the INSTALL(PROGRAMS ) command instead.";
}
/**
Index: cmInstallTargetsCommand.h
===================================================================
RCS file: /cvsroot/CMake/CMake/Source/cmInstallTargetsCommand.h,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -d -r1.13 -r1.14
--- cmInstallTargetsCommand.h 1 Sep 2006 13:51:28 -0000 1.13
+++ cmInstallTargetsCommand.h 24 Jan 2007 18:45:42 -0000 1.14
@@ -53,7 +53,7 @@
*/
virtual const char* GetTerseDocumentation()
{
- return "Old installation command. Use the INSTALL command.";
+ return "Deprecated. Use the INSTALL(TARGETS ) command instead.";
}
/**
Index: cmWriteFileCommand.h
===================================================================
RCS file: /cvsroot/CMake/CMake/Source/cmWriteFileCommand.h,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -d -r1.9 -r1.10
--- cmWriteFileCommand.h 22 Jan 2007 15:52:27 -0000 1.9
+++ cmWriteFileCommand.h 24 Jan 2007 18:45:42 -0000 1.10
@@ -55,7 +55,7 @@
*/
virtual const char* GetTerseDocumentation()
{
- return "Write a message to a file.";
+ return "Deprecated. Use the FILE(WRITE ) command instead.";
}
/**
Index: cmInstallFilesCommand.h
===================================================================
RCS file: /cvsroot/CMake/CMake/Source/cmInstallFilesCommand.h,v
retrieving revision 1.18
retrieving revision 1.19
diff -u -d -r1.18 -r1.19
--- cmInstallFilesCommand.h 1 Sep 2006 13:51:28 -0000 1.18
+++ cmInstallFilesCommand.h 24 Jan 2007 18:45:42 -0000 1.19
@@ -52,7 +52,7 @@
*/
virtual const char* GetTerseDocumentation()
{
- return "Old installation command. Use the INSTALL command.";
+ return "Deprecated. Use the INSTALL(FILES ) command instead.";
}
/**
Index: cmMakeDirectoryCommand.h
===================================================================
RCS file: /cvsroot/CMake/CMake/Source/cmMakeDirectoryCommand.h,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -d -r1.10 -r1.11
--- cmMakeDirectoryCommand.h 1 Sep 2006 13:51:28 -0000 1.10
+++ cmMakeDirectoryCommand.h 24 Jan 2007 18:45:42 -0000 1.11
@@ -60,7 +60,7 @@
*/
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 @@
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 "
Index: cmSubdirCommand.h
===================================================================
RCS file: /cvsroot/CMake/CMake/Source/cmSubdirCommand.h,v
retrieving revision 1.17
retrieving revision 1.18
diff -u -d -r1.17 -r1.18
--- cmSubdirCommand.h 1 Sep 2006 13:51:28 -0000 1.17
+++ cmSubdirCommand.h 24 Jan 2007 18:45:42 -0000 1.18
@@ -53,7 +53,7 @@
*/
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 @@
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 "
Index: cmRemoveCommand.h
===================================================================
RCS file: /cvsroot/CMake/CMake/Source/cmRemoveCommand.h,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -d -r1.8 -r1.9
--- cmRemoveCommand.h 1 Sep 2006 13:51:28 -0000 1.8
+++ cmRemoveCommand.h 24 Jan 2007 18:45:42 -0000 1.9
@@ -56,7 +56,7 @@
*/
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 @@
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 "
Index: cmSubdirDependsCommand.h
===================================================================
RCS file: /cvsroot/CMake/CMake/Source/cmSubdirDependsCommand.h,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -d -r1.9 -r1.10
--- cmSubdirDependsCommand.h 1 Sep 2006 13:51:28 -0000 1.9
+++ cmSubdirDependsCommand.h 24 Jan 2007 18:45:42 -0000 1.10
@@ -53,7 +53,7 @@
*/
virtual const char* GetTerseDocumentation()
{
- return "Legacy command. Does nothing.";
+ return "Deprecated. Does nothing.";
}
/**
Index: cmLinkLibrariesCommand.h
===================================================================
RCS file: /cvsroot/CMake/CMake/Source/cmLinkLibrariesCommand.h,v
retrieving revision 1.17
retrieving revision 1.18
diff -u -d -r1.17 -r1.18
--- cmLinkLibrariesCommand.h 1 Sep 2006 13:51:28 -0000 1.17
+++ cmLinkLibrariesCommand.h 24 Jan 2007 18:45:42 -0000 1.18
@@ -53,7 +53,7 @@
*/
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 @@
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 "
Index: cmExecProgramCommand.h
===================================================================
RCS file: /cvsroot/CMake/CMake/Source/cmExecProgramCommand.h,v
retrieving revision 1.19
retrieving revision 1.20
diff -u -d -r1.19 -r1.20
--- cmExecProgramCommand.h 1 Sep 2006 13:51:28 -0000 1.19
+++ cmExecProgramCommand.h 24 Jan 2007 18:45:42 -0000 1.20
@@ -60,8 +60,7 @@
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 @@
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 @@
"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."
;
}
Index: cmVariableRequiresCommand.h
===================================================================
RCS file: /cvsroot/CMake/CMake/Source/cmVariableRequiresCommand.h,v
retrieving revision 1.12
retrieving revision 1.13
diff -u -d -r1.12 -r1.13
--- cmVariableRequiresCommand.h 24 Jan 2007 18:40:31 -0000 1.12
+++ cmVariableRequiresCommand.h 24 Jan 2007 18:45:42 -0000 1.13
@@ -50,7 +50,7 @@
*/
virtual const char* GetTerseDocumentation()
{
- return "Assert satisfaction of an option's required variables.";
+ return "Deprecated. Use the IF() command instead.";
}
/**
@@ -59,6 +59,7 @@
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"
More information about the Cmake-commits
mailing list