Updates will be applied April 15th at 12pm EDT (UTC-0400). GitLab could be a little slow between 12 - 12:45pm EDT.

Commit 8d32d229 authored by Ken Martin's avatar Ken Martin

ENH: make commands lower case by default

parent 8e4c7b99
......@@ -47,7 +47,7 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() {return "ADD_CUSTOM_COMMAND";}
virtual const char* GetName() {return "add_custom_command";}
/**
* Succinct documentation.
......@@ -63,10 +63,10 @@ public:
virtual const char* GetFullDocumentation()
{
return
"There are two main signatures for ADD_CUSTOM_COMMAND "
"There are two main signatures for add_custom_command "
"The first signature is for adding a custom command "
"to produce an output.\n"
" ADD_CUSTOM_COMMAND(OUTPUT output1 [output2 ...]\n"
" add_custom_command(OUTPUT output1 [output2 ...]\n"
" COMMAND command1 [ARGS] [args1...]\n"
" [COMMAND command2 [ARGS] [args2...] ...]\n"
" [MAIN_DEPENDENCY depend]\n"
......@@ -92,7 +92,7 @@ public:
"The command becomes part of the target and will only execute "
"when the target itself is built. If the target is already built,"
" the command will not execute.\n"
" ADD_CUSTOM_COMMAND(TARGET target\n"
" add_custom_command(TARGET target\n"
" PRE_BUILD | PRE_LINK | POST_BUILD\n"
" COMMAND command1 [ARGS] [args1...]\n"
" [COMMAND command2 [ARGS] [args2...] ...]\n"
......
......@@ -47,7 +47,7 @@ public:
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName()
{return "ADD_CUSTOM_TARGET";}
{return "add_custom_target";}
/**
* Succinct documentation.
......@@ -63,7 +63,7 @@ public:
virtual const char* GetFullDocumentation()
{
return
" ADD_CUSTOM_TARGET(Name [ALL] [command1 [args1...]]\n"
" add_custom_target(Name [ALL] [command1 [args1...]]\n"
" [COMMAND command2 [args2...] ...]\n"
" [DEPENDS depend depend depend ... ]\n"
" [WORKING_DIRECTORY dir]\n"
......@@ -89,7 +89,7 @@ public:
"If VERBATIM is given then all the arguments to the commands will be "
"passed exactly as specified no matter the build tool used. "
"Note that one level of escapes is still used by the CMake language "
"processor before ADD_CUSTOM_TARGET even sees the arguments. "
"processor before add_custom_target even sees the arguments. "
"Use of VERBATIM is recommended as it enables correct behavior. "
"When VERBATIM is not given the behavior is platform specific. "
"In the future VERBATIM may be enabled by default. The only reason "
......
......@@ -45,7 +45,7 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() {return "ADD_DEFINITIONS";}
virtual const char* GetName() {return "add_definitions";}
/**
* Succinct documentation.
......@@ -61,7 +61,7 @@ public:
virtual const char* GetFullDocumentation()
{
return
" ADD_DEFINITIONS(-DFOO -DBAR ...)\n"
" add_definitions(-DFOO -DBAR ...)\n"
"Adds flags to command line of C and C++ compilers. "
"This command can be used to add any flag to a compile line, "
"but the -D flag is accepted most C/C++ compilers. "
......
......@@ -44,7 +44,7 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "ADD_DEPENDENCIES";}
virtual const char* GetName() { return "add_dependencies";}
/**
* Succinct documentation.
......@@ -60,7 +60,7 @@ public:
virtual const char* GetFullDocumentation()
{
return
" ADD_DEPENDENCIES(target-name depend-target1\n"
" add_dependencies(target-name depend-target1\n"
" depend-target2 ...)\n"
"Make a top-level target depend on other top-level targets. A "
"top-level target is one created by ADD_EXECUTABLE, ADD_LIBRARY, "
......
......@@ -45,7 +45,7 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "ADD_EXECUTABLE";}
virtual const char* GetName() { return "add_executable";}
/**
* Succinct documentation.
......@@ -62,7 +62,7 @@ public:
virtual const char* GetFullDocumentation()
{
return
" ADD_EXECUTABLE(exename [WIN32] [MACOSX_BUNDLE] [EXCLUDE_FROM_ALL]\n"
" add_executable(exename [WIN32] [MACOSX_BUNDLE] [EXCLUDE_FROM_ALL]\n"
" source1 source2 ... sourceN)\n"
"This command adds an executable target to the current directory. "
"The executable will be built from the list of source files "
......
......@@ -45,7 +45,7 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "ADD_LIBRARY";}
virtual const char* GetName() { return "add_library";}
/**
* Succinct documentation.
......@@ -61,7 +61,7 @@ public:
virtual const char* GetFullDocumentation()
{
return
" ADD_LIBRARY(libname [SHARED | STATIC | MODULE] [EXCLUDE_FROM_ALL]\n"
" add_library(libname [SHARED | STATIC | MODULE] [EXCLUDE_FROM_ALL]\n"
" source1 source2 ... sourceN)\n"
"Adds a library target. SHARED, STATIC or MODULE keywords are used "
"to set the library type. If the keyword MODULE appears, the library "
......
......@@ -46,7 +46,7 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "ADD_SUBDIRECTORY";}
virtual const char* GetName() { return "add_subdirectory";}
/**
* Succinct documentation.
......@@ -62,7 +62,7 @@ public:
virtual const char* GetFullDocumentation()
{
return
" ADD_SUBDIRECTORY(source_dir [binary_dir] \n"
" add_subdirectory(source_dir [binary_dir] \n"
" [EXCLUDE_FROM_ALL])\n"
"Add a subdirectory to the build. The source_dir specifies the "
"directory in which the source CmakeLists.txt and code files are "
......
......@@ -44,7 +44,7 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "ADD_TEST";}
virtual const char* GetName() { return "add_test";}
/**
* Succinct documentation.
......@@ -60,7 +60,7 @@ public:
virtual const char* GetFullDocumentation()
{
return
" ADD_TEST(testname Exename arg1 arg2 ...)\n"
" add_test(testname Exename arg1 arg2 ...)\n"
"If the ENABLE_TESTING command has been run, this command adds a "
"test target to the current directory. If ENABLE_TESTING has not "
"been run, this command does nothing. "
......
......@@ -48,7 +48,7 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "AUX_SOURCE_DIRECTORY";}
virtual const char* GetName() { return "aux_source_directory";}
/**
* Succinct documentation.
......@@ -64,7 +64,7 @@ public:
virtual const char* GetFullDocumentation()
{
return
" AUX_SOURCE_DIRECTORY(dir VARIABLE)\n"
" aux_source_directory(dir VARIABLE)\n"
"Collects the names of all the source files in the specified "
"directory and stores the list in the variable provided. This "
"command is intended to be used by projects that use explicit "
......
......@@ -44,7 +44,7 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() {return "BUILD_COMMAND";}
virtual const char* GetName() {return "build_command";}
/**
* Succinct documentation.
......@@ -60,7 +60,7 @@ public:
virtual const char* GetFullDocumentation()
{
return
" BUILD_COMMAND(variable MAKECOMMAND)\n"
" build_command(variable MAKECOMMAND)\n"
"Sets the given variable to a string containing the command that "
"will build this project from the root of the build tree using the "
"build tool given by MAKECOMMAND. MAKECOMMAND should be msdev, "
......
......@@ -49,7 +49,7 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() {return "BUILD_NAME";}
virtual const char* GetName() {return "build_name";}
/**
* Succinct documentation.
......@@ -66,7 +66,7 @@ public:
virtual const char* GetFullDocumentation()
{
return
" BUILD_NAME(variable)\n"
" build_name(variable)\n"
"Sets the specified variable to a string representing the platform "
"and compiler settings. These values are now available through the "
"CMAKE_SYSTEM and CMAKE_CXX_COMPILER variables.";
......
......@@ -49,7 +49,7 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() {return "CMAKE_MINIMUM_REQUIRED";}
virtual const char* GetName() {return "cmake_minimum_required";}
/**
* Succinct documentation.
......@@ -65,7 +65,7 @@ public:
virtual const char* GetFullDocumentation()
{
return
" CMAKE_MINIMUM_REQUIRED(VERSION versionNumber [FATAL_ERROR])\n"
" cmake_minimum_required(VERSION versionNumber [FATAL_ERROR])\n"
"Let cmake know that the project requires a certain version of a "
"cmake, or newer. CMake will also try to be backwards compatible to "
"the version of cmake specified, if a newer version of cmake is "
......
......@@ -38,7 +38,7 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "CONFIGURE_FILE";}
virtual const char* GetName() { return "configure_file";}
/**
* This determines if the command is invoked when in script mode.
......@@ -59,7 +59,7 @@ public:
virtual const char* GetFullDocumentation()
{
return
" CONFIGURE_FILE(InputFile OutputFile\n"
" configure_file(InputFile OutputFile\n"
" [COPYONLY] [ESCAPE_QUOTES] [@ONLY])\n"
"The Input and Ouput files have to have full paths. "
"This command replaces any variables in the input file referenced as "
......
......@@ -44,7 +44,7 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() {return "CREATE_TEST_SOURCELIST";}
virtual const char* GetName() {return "create_test_sourcelist";}
/**
* Succinct documentation.
......@@ -60,7 +60,7 @@ public:
virtual const char* GetFullDocumentation()
{
return
" CREATE_TEST_SOURCELIST(SourceListName DriverName\n"
" create_test_sourcelist(SourceListName DriverName\n"
" test1 test2 test3\n"
" EXTRA_INCLUDE include.h\n"
" FUNCTION function)\n"
......
......@@ -36,7 +36,7 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "DEFINE_PROPERTY";}
virtual const char* GetName() { return "define_property";}
/**
* Succinct documentation.
......@@ -52,7 +52,7 @@ public:
virtual const char* GetFullDocumentation()
{
return
" DEFINE_PROPERTY(property_name scope_value\n"
" define_property(property_name scope_value\n"
" short_description\n"
" full_description inherit)\n"
"Define a property for a scope. scope_value is either GLOBAL, "
......
......@@ -696,7 +696,7 @@ bool cmDocumentation::CheckOptions(int argc, const char* const* argv)
help.HelpType = cmDocumentation::Usage;
help.HelpForm = cmDocumentation::UsageForm;
GET_OPT_ARGUMENT(help.Argument);
help.Argument = cmSystemTools::UpperCase(help.Argument);
help.Argument = cmSystemTools::LowerCase(help.Argument);
// special case for single command
if (!help.Argument.empty())
{
......@@ -756,7 +756,7 @@ bool cmDocumentation::CheckOptions(int argc, const char* const* argv)
help.HelpType = cmDocumentation::Single;
GET_OPT_ARGUMENT(help.Argument);
GET_OPT_ARGUMENT(help.Filename);
help.Argument = cmSystemTools::UpperCase(help.Argument);
help.Argument = cmSystemTools::LowerCase(help.Argument);
help.HelpForm = this->GetFormFromFilename(help.Filename);
}
else if(strcmp(argv[i], "--help-module") == 0)
......
......@@ -49,14 +49,14 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "ELSE";}
virtual const char* GetName() { return "else";}
/**
* Succinct documentation.
*/
virtual const char* GetTerseDocumentation()
{
return "Starts the ELSE portion of an IF block.";
return "Starts the else portion of an if block.";
}
/**
......@@ -65,8 +65,8 @@ public:
virtual const char* GetFullDocumentation()
{
return
" ELSE(expression)\n"
"See the IF command.";
" else(expression)\n"
"See the if command.";
}
cmTypeMacro(cmElseCommand, cmCommand);
......
......@@ -49,14 +49,14 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "ELSEIF";}
virtual const char* GetName() { return "elseif";}
/**
* Succinct documentation.
*/
virtual const char* GetTerseDocumentation()
{
return "Starts the ELSEIF portion of an IF block.";
return "Starts the elseif portion of an if block.";
}
/**
......@@ -65,8 +65,8 @@ public:
virtual const char* GetFullDocumentation()
{
return
" ELSEIF(expression)\n"
"See the IF command.";
" elseif(expression)\n"
"See the if command.";
}
cmTypeMacro(cmElseIfCommand, cmCommand);
......
......@@ -47,7 +47,7 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() {return "ENABLE_LANGUAGE";}
virtual const char* GetName() {return "enable_language";}
/**
* Succinct documentation.
......@@ -63,7 +63,7 @@ public:
virtual const char* GetFullDocumentation()
{
return
" ENABLE_LANGUAGE(languageName [OPTIONAL] )\n"
" enable_language(languageName [OPTIONAL] )\n"
"This command enables support for the named language in CMake. "
"This is the same as the project command but does not create "
"any of the extra varaibles that are created by the project command. "
......
......@@ -52,7 +52,7 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "ENABLE_TESTING";}
virtual const char* GetName() { return "enable_testing";}
/**
* Succinct documentation.
......@@ -68,9 +68,9 @@ public:
virtual const char* GetFullDocumentation()
{
return
" ENABLE_TESTING()\n"
" enable_testing()\n"
"Enables testing for this directory and below. "
"See also the ADD_TEST command. Note that ctest expects to find "
"See also the add_test command. Note that ctest expects to find "
"a test file in the build directory root. Therefore, this command "
"should be in the source directory root.";
}
......
......@@ -55,7 +55,7 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "ENDFOREACH";}
virtual const char* GetName() { return "endforeach";}
/**
* Succinct documentation.
......@@ -71,7 +71,7 @@ public:
virtual const char* GetFullDocumentation()
{
return
" ENDFOREACH(expression)\n"
" endforeach(expression)\n"
"See the FOREACH command.";
}
......
......@@ -49,14 +49,14 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "ENDIF";}
virtual const char* GetName() { return "endif";}
/**
* Succinct documentation.
*/
virtual const char* GetTerseDocumentation()
{
return "Ends a list of commands in an IF block.";
return "Ends a list of commands in an if block.";
}
/**
......@@ -65,8 +65,8 @@ public:
virtual const char* GetFullDocumentation()
{
return
" ENDIF(expression)\n"
"See the IF command.";
" endif(expression)\n"
"See the if command.";
}
cmTypeMacro(cmEndIfCommand, cmCommand);
......
......@@ -55,14 +55,14 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "ENDMACRO";}
virtual const char* GetName() { return "endmacro";}
/**
* Succinct documentation.
*/
virtual const char* GetTerseDocumentation()
{
return "Ends a list of commands in a MACRO block.";
return "Ends a list of commands in a macro block.";
}
/**
......@@ -71,8 +71,8 @@ public:
virtual const char* GetFullDocumentation()
{
return
" ENDMACRO(expression)\n"
"See the MACRO command.";
" endmacro(expression)\n"
"See the macro command.";
}
cmTypeMacro(cmEndMacroCommand, cmCommand);
......
......@@ -55,14 +55,14 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "ENDWHILE";}
virtual const char* GetName() { return "endwhile";}
/**
* Succinct documentation.
*/
virtual const char* GetTerseDocumentation()
{
return "Ends a list of commands in a WHILE block.";
return "Ends a list of commands in a while block.";
}
/**
......@@ -71,8 +71,8 @@ public:
virtual const char* GetFullDocumentation()
{
return
" ENDWHILE(expression)\n"
"See the WHILE command.";
" endwhile(expression)\n"
"See the while command.";
}
cmTypeMacro(cmEndWhileCommand, cmCommand);
......
......@@ -47,7 +47,7 @@ public:
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName()
{return "EXEC_PROGRAM";}
{return "exec_program";}
/**
* This determines if the command is invoked when in script mode.
......@@ -60,7 +60,7 @@ public:
virtual const char* GetTerseDocumentation()
{
return
"Deprecated. Use the EXECUTE_PROCESS() command instead.";
"Deprecated. Use the execute_process() command instead.";
}
/**
......@@ -71,7 +71,7 @@ public:
return
"Run an executable program during the processing of the CMakeList.txt"
" file.\n"
" EXEC_PROGRAM(Executable [directory in which to run]\n"
" exec_program(Executable [directory in which to run]\n"
" [ARGS <arguments to executable>]\n"
" [OUTPUT_VARIABLE <var>]\n"
" [RETURN_VALUE <var>])\n"
......
......@@ -46,7 +46,7 @@ public:
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName()
{return "EXECUTE_PROCESS";}
{return "execute_process";}
/**
* This determines if the command is invoked when in script mode.
......@@ -67,7 +67,7 @@ public:
virtual const char* GetFullDocumentation()
{
return
" EXECUTE_PROCESS(COMMAND <cmd1> [args1...]]\n"
" execute_process(COMMAND <cmd1> [args1...]]\n"
" [COMMAND <cmd2> [args2...] [...]]\n"
" [WORKING_DIRECTORY <directory>]\n"
" [TIMEOUT <seconds>]\n"
......@@ -106,8 +106,8 @@ public:
"pipe the precedence is not specified. "
"If no OUTPUT_* or ERROR_* options are given the output will be shared "
"with the corresponding pipes of the CMake process itself.\n"
"The EXECUTE_PROCESS command is a newer more powerful version of "
"EXEC_PROGRAM, but the old command has been kept for compatibility."
"The execute_process command is a newer more powerful version of "
"exec_program, but the old command has been kept for compatibility."
;
}
......
......@@ -46,7 +46,7 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "EXPORT";}
virtual const char* GetName() { return "export";}
/**
* Succinct documentation.
......@@ -63,7 +63,7 @@ public:
virtual const char* GetFullDocumentation()
{
return
" EXPORT(TARGETS tgt1 tgt2 ... [PREFIX <prefix>] FILE <filename> "
" export(TARGETS tgt1 tgt2 ... [PREFIX <prefix>] FILE <filename> "
"[APPEND])\n"
"Create a file that can be included into a CMake listfile with the "
"INCLUDE command. The file will contain a number of SET commands "
......
......@@ -51,7 +51,7 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "EXPORT_LIBRARY_DEPENDENCIES";}
virtual const char* GetName() { return "export_library_dependencies";}
/**
* Succinct documentation.
......@@ -68,7 +68,7 @@ public:
virtual const char* GetFullDocumentation()
{
return
" EXPORT_LIBRARY_DEPENDENCIES(FILE [APPEND])\n"
" export_library_dependencies(FILE [APPEND])\n"
"Create a file that can be included into a CMake listfile with the "
"INCLUDE command. The file will contain a number of SET commands "
"that will set all the variables needed for library dependency "
......