kolan
/
CMake
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

ENH: make commands lower case by default

This commit is contained in:
Ken Martin 2007-10-10 11:47:43 -04:00
parent 8e4c7b99e1
commit 8d32d229a3
95 changed files with 345 additions and 346 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
Source/cmAddCustomCommandCommand.h
View File

@ -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"

6
Source/cmAddCustomTargetCommand.h
View File

@ -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 "

4
Source/cmAddDefinitionsCommand.h
View File

@ -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. "

4
Source/cmAddDependenciesCommand.h
View File

@ -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, "

4
Source/cmAddExecutableCommand.h
View File

@ -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 "

4
Source/cmAddLibraryCommand.h
View File

@ -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 "

4
Source/cmAddSubDirectoryCommand.h
View File

@ -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 "

4
Source/cmAddTestCommand.h
View File

@ -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. "

4
Source/cmAuxSourceDirectoryCommand.h
View File

@ -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 "

4
Source/cmBuildCommand.h
View File

@ -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, "

4
Source/cmBuildNameCommand.h
View File

@ -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.";

4
Source/cmCMakeMinimumRequired.h
View File

@ -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 "

4
Source/cmConfigureFileCommand.h
View File

@ -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 "

4
Source/cmCreateTestSourceList.h
View File

@ -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"

4
Source/cmDefinePropertyCommand.h
View File

@ -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, "

4
Source/cmDocumentation.cxx
View File

@ -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)

8
Source/cmElseCommand.h
View File

@ -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);

8
Source/cmElseIfCommand.h
View File

@ -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);

4
Source/cmEnableLanguageCommand.h
View File

@ -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. "

6
Source/cmEnableTestingCommand.h
View File

@ -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.";
}

4
Source/cmEndForEachCommand.h
View File

@ -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.";
}

8
Source/cmEndIfCommand.h
View File

@ -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);

8
Source/cmEndMacroCommand.h
View File

@ -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);

8
Source/cmEndWhileCommand.h
View File

@ -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);

6
Source/cmExecProgramCommand.h
View File

@ -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"

8
Source/cmExecuteProcessCommand.h
View File

@ -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."
;
}

4
Source/cmExportCommand.h
View File

@ -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 "

4
Source/cmExportLibraryDependencies.h
View File

@ -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 "

4
Source/cmFLTKWrapUICommand.h
View File

@ -55,7 +55,7 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "FLTK_WRAP_UI";}
virtual const char* GetName() { return "fltk_wrap_ui";}
/**
* Succinct documentation.
@ -71,7 +71,7 @@ public:
virtual const char* GetFullDocumentation()
{
return
" FLTK_WRAP_UI(resultingLibraryName source1\n"
" fltk_wrap_ui(resultingLibraryName source1\n"
" source2 ... sourceN )\n"
"Produce .h and .cxx files for all the .fl and .fld files listed. "
"The resulting .h and .cxx files will be added to a variable named "

43
Source/cmFileCommand.h
View File

@ -50,7 +50,7 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "FILE";}
virtual const char* GetName() { return "file";}
/**
* Succinct documentation.
@ -66,31 +66,31 @@ public:
virtual const char* GetFullDocumentation()
{
return
" FILE(WRITE filename \"message to write\"... )\n"
" FILE(APPEND filename \"message to write\"... )\n"
" FILE(READ filename variable [LIMIT numBytes])\n"
" FILE(STRINGS filename variable [LIMIT_COUNT num]\n"
" file(WRITE filename \"message to write\"... )\n"
" file(APPEND filename \"message to write\"... )\n"
" file(READ filename variable [LIMIT numBytes])\n"
" file(STRINGS filename variable [LIMIT_COUNT num]\n"
" [LIMIT_INPUT numBytes] [LIMIT_OUTPUT numBytes]\n"
" [LENGTH_MINIMUM numBytes] [LENGTH_MAXIMUM numBytes]\n"
" [NEWLINE_CONSUME] [REGEX regex]\n"
" [NO_HEX_CONVERSION])\n"
" FILE(GLOB variable [RELATIVE path] [globbing expressions]...)\n"
" FILE(GLOB_RECURSE variable [RELATIVE path] \n"
" file(GLOB variable [RELATIVE path] [globbing expressions]...)\n"
" file(GLOB_RECURSE variable [RELATIVE path] \n"
" [globbing expressions]...)\n"
" FILE(REMOVE [file1 ...])\n"
" FILE(REMOVE_RECURSE [file1 ...])\n"
" FILE(MAKE_DIRECTORY [directory1 directory2 ...])\n"
" FILE(RELATIVE_PATH variable directory file)\n"
" FILE(TO_CMAKE_PATH path result)\n"
" FILE(TO_NATIVE_PATH path result)\n"
" file(REMOVE [file1 ...])\n"
" file(REMOVE_RECURSE [file1 ...])\n"
" file(MAKE_DIRECTORY [directory1 directory2 ...])\n"
" file(RELATIVE_PATH variable directory file)\n"
" file(TO_CMAKE_PATH path result)\n"
" file(TO_NATIVE_PATH path result)\n"
"WRITE will write a message into a file called 'filename'. It "
"overwrites the file if it already exists, and creates the file "
"if it does not exist.\n"
"APPEND will write a message into a file same as WRITE, except "
"it will append it to the end of the file\n"
"NOTE: When using FILE WRITE and FILE APPEND, the produced file "
"cannot be used as an input to CMake (CONFIGURE_FILE, source file ...) "
"because it will lead to an infinite loop. Use CONFIGURE_FILE if you "
"NOTE: When using file WRITE and file APPEND, the produced file "
"cannot be used as an input to CMake (configure_file, source file ...) "
"because it will lead to an infinite loop. Use configure_file if you "
"want to generate input files to CMake.\n"
"READ will read the content of a file and store it into the "
"variable.\n"
@ -98,7 +98,7 @@ public:
"store it in a variable. Binary data in the file are ignored. Carriage "
"return (CR) characters are ignored. It works also for Intel Hex and "
"Motorola S-record files, which are automatically converted to binary "
"format when reading them. Disable this using NO_HEX_CONVERSION.\n "
"format when reading them. Disable this using NO_HEX_CONVERSION.\n"
"LIMIT_COUNT sets the maximum number of strings to return. "
"LIMIT_INPUT sets the maximum number of bytes to read from "
"the input file. "
@ -109,11 +109,10 @@ public:
"LENGTH_MAXIMUM sets the maximum length of a string to return. Longer "
"strings are split into strings no longer than the maximum length. "
"NEWLINE_CONSUME allows newlines to be included in strings instead "
"of terminating them. "
"of terminating them.\n"
"REGEX specifies a regular expression that a string must match to be "
"returned. "
"Typical usage \n"
" FILE(STRINGS myfile.txt myfile)\n"
"returned. Typical usage \n"
" file(STRINGS myfile.txt myfile)\n"
"stores a list in the variable \"myfile\" in which each item is "
"a line from the input file.\n"
"GLOB will generate a list of all files that match the globbing "
@ -160,7 +159,7 @@ protected:
bool HandleCMakePathCommand(std::vector<std::string> const& args,
bool nativePath);
// FILE(INSTALL ...) related functions
// file(INSTALL ...) related functions
bool HandleInstallCommand(std::vector<std::string> const& args);
bool ParseInstallArgs(std::vector<std::string> const& args,
cmFileInstaller& installer,

2
Source/cmFindFileCommand.cxx
View File

@ -21,7 +21,7 @@ cmFindFileCommand::cmFindFileCommand()
{
this->IncludeFileInPath = true;
cmSystemTools::ReplaceString(this->GenericDocumentation,
"FIND_PATH", "FIND_FILE");
"FIND_PATH", "find_file");
cmSystemTools::ReplaceString(this->GenericDocumentation,
"directory containing the named file",
"full path to named file");

2
Source/cmFindFileCommand.h
View File

@ -38,7 +38,7 @@ public:
{
return new cmFindFileCommand;
}
virtual const char* GetName() { return "FIND_FILE";}
virtual const char* GetName() { return "find_file";}
/**
* Succinct documentation.

2
Source/cmFindLibraryCommand.cxx
View File

@ -20,7 +20,7 @@
cmFindLibraryCommand::cmFindLibraryCommand()
{
cmSystemTools::ReplaceString(this->GenericDocumentation,
"FIND_XXX", "FIND_LIBRARY");
"FIND_XXX", "find_library");
cmSystemTools::ReplaceString(this->GenericDocumentation,
"CMAKE_XXX_PATH", "CMAKE_LIBRARY_PATH");
cmSystemTools::ReplaceString(this->GenericDocumentation,

2
Source/cmFindLibraryCommand.h
View File

@ -53,7 +53,7 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() {return "FIND_LIBRARY";}
virtual const char* GetName() {return "find_library";}
/**
* Succinct documentation.

4
Source/cmFindPackageCommand.h
View File

@ -49,7 +49,7 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "FIND_PACKAGE";}
virtual const char* GetName() { return "find_package";}
/**
* Succinct documentation.
@ -65,7 +65,7 @@ public:
virtual const char* GetFullDocumentation()
{
return
" FIND_PACKAGE(<name> [major.minor] [QUIET] [NO_MODULE]\n"
" find_package(<name> [major.minor] [QUIET] [NO_MODULE]\n"
" [[REQUIRED|COMPONENTS] [components...]])\n"
"Finds and loads settings from an external project. <name>_FOUND will "
"be set to indicate whether the package was found. Settings that "

2
Source/cmFindPathCommand.cxx
View File

@ -23,7 +23,7 @@ cmFindPathCommand::cmFindPathCommand()
{
this->IncludeFileInPath = false;
cmSystemTools::ReplaceString(this->GenericDocumentation,
"FIND_XXX", "FIND_PATH");
"FIND_XXX", "find_path");
cmSystemTools::ReplaceString(this->GenericDocumentation,
"CMAKE_XXX_PATH", "CMAKE_INCLUDE_PATH");
cmSystemTools::ReplaceString(this->GenericDocumentation,

2
Source/cmFindPathCommand.h
View File

@ -53,7 +53,7 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() {return "FIND_PATH";}
virtual const char* GetName() {return "find_path";}
/**
* Succinct documentation.

2
Source/cmFindProgramCommand.cxx
View File

@ -25,7 +25,7 @@
cmFindProgramCommand::cmFindProgramCommand()
{
cmSystemTools::ReplaceString(this->GenericDocumentation,
"FIND_XXX", "FIND_PROGRAM");
"FIND_XXX", "find_program");
cmSystemTools::ReplaceString(this->GenericDocumentation,
"CMAKE_XXX_PATH", "CMAKE_PROGRAM_PATH");
cmSystemTools::ReplaceString(this->GenericDocumentation,

2
Source/cmFindProgramCommand.h
View File

@ -53,7 +53,7 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "FIND_PROGRAM";}
virtual const char* GetName() { return "find_program";}
/**
* Succinct documentation.

16
Source/cmForEachCommand.h
View File

@ -73,7 +73,7 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "FOREACH";}
virtual const char* GetName() { return "foreach";}
/**
* Succinct documentation.
@ -89,17 +89,17 @@ public:
virtual const char* GetFullDocumentation()
{
return
" FOREACH(loop_var arg1 arg2 ...)\n"
" foreach(loop_var arg1 arg2 ...)\n"
" COMMAND1(ARGS ...)\n"
" COMMAND2(ARGS ...)\n"
" ...\n"
" ENDFOREACH(loop_var)\n"
" FOREACH(loop_var RANGE total)\n"
" FOREACH(loop_var RANGE start stop [step])\n"
"All commands between FOREACH and the matching ENDFOREACH are recorded "
"without being invoked. Once the ENDFOREACH is evaluated, the "
" ENDforeach(loop_var)\n"
" foreach(loop_var RANGE total)\n"
" foreach(loop_var RANGE start stop [step])\n"
"All commands between foreach and the matching ENDforeach are recorded "
"without being invoked. Once the ENDforeach is evaluated, the "
"recorded list of commands is invoked once for each argument listed "
"in the original FOREACH command. Before each iteration of the loop "
"in the original foreach command. Before each iteration of the loop "
"\"${loop_var}\" will be set as a variable with "
"the current value in the list.\n"
"Foreach can also iterate over a generated range of numbers. "

4
Source/cmGetCMakePropertyCommand.h
View File

@ -41,7 +41,7 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "GET_CMAKE_PROPERTY";}
virtual const char* GetName() { return "get_cmake_property";}
/**
* Succinct documentation.
@ -57,7 +57,7 @@ public:
virtual const char* GetFullDocumentation()
{
return
" GET_CMAKE_PROPERTY(VAR property)\n"
" get_cmake_property(VAR property)\n"
"Get a property from the CMake instance. The value of the "
"property is stored in the variable VAR. If the property is "
"not found, CMake will report an error. Some supported properties "

4
Source/cmGetDirectoryPropertyCommand.h
View File

@ -41,7 +41,7 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "GET_DIRECTORY_PROPERTY";}
virtual const char* GetName() { return "get_directory_property";}
/**
* Succinct documentation.
@ -57,7 +57,7 @@ public:
virtual const char* GetFullDocumentation()
{
return
" GET_DIRECTORY_PROPERTY(VAR [DIRECTORY dir] property)\n"
" get_directory_property(VAR [DIRECTORY dir] property)\n"
"Get a property from the Directory. The value of the property is "
"stored in the variable VAR. If the property is not found, "
"CMake will report an error. The properties include: VARIABLES, "

6
Source/cmGetFilenameComponentCommand.h
View File

@ -50,7 +50,7 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "GET_FILENAME_COMPONENT";}
virtual const char* GetName() { return "get_filename_component";}
/**
* Succinct documentation.
@ -66,7 +66,7 @@ public:
virtual const char* GetFullDocumentation()
{
return
" GET_FILENAME_COMPONENT(VarName FileName\n"
" get_filename_component(VarName FileName\n"
" PATH|ABSOLUTE|NAME|EXT|NAME_WE\n"
" [CACHE])\n"
"Set VarName to be the path (PATH), file name (NAME), file "
@ -76,7 +76,7 @@ public:
"trailing slashes. The longest file extension is always considered. "
"If the optional CACHE argument is specified, the result variable is "
"added to the cache.\n"
" GET_FILENAME_COMPONENT(VarName FileName\n"
" get_filename_component(VarName FileName\n"
" PROGRAM [PROGRAM_ARGS ArgVar]\n"
" [CACHE])\n"
"The program in FileName will be found in the system search path or "

4
Source/cmGetPropertyCommand.h
View File

@ -41,7 +41,7 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "GET_PROPERTY";}
virtual const char* GetName() { return "get_property";}
/**
* Succinct documentation.
@ -57,7 +57,7 @@ public:
virtual const char* GetFullDocumentation()
{
return
" GET_PROPERTY(VAR scope_value property)\n"
" get_property(VAR scope_value property)\n"
"Get a property from cmake. The scope_value is either GLOBAL, "
"DIRECTORY dir_name, TARGET tgt_name, SOURCE_FILE src_name, "
"or TEST test_name. The resulting value is "

6
Source/cmGetSourceFilePropertyCommand.h
View File

@ -36,7 +36,7 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "GET_SOURCE_FILE_PROPERTY";}
virtual const char* GetName() { return "get_source_file_property";}
/**
* Succinct documentation.
@ -52,10 +52,10 @@ public:
virtual const char* GetFullDocumentation()
{
return
" GET_SOURCE_FILE_PROPERTY(VAR file property)\n"
" get_source_file_property(VAR file property)\n"
"Get a property from a source file. The value of the property is "
"stored in the variable VAR. If the property is not found, VAR "
"will be set to \"NOTFOUND\". Use SET_SOURCE_FILES_PROPERTIES to set "
"will be set to \"NOTFOUND\". Use set_source_files_properties to set "
"property values. Source file properties usually control how the "
"file is built. One property that is always there is LOCATION";
}

6
Source/cmGetTargetPropertyCommand.h
View File

@ -36,7 +36,7 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "GET_TARGET_PROPERTY";}
virtual const char* GetName() { return "get_target_property";}
/**
* Succinct documentation.
@ -52,10 +52,10 @@ public:
virtual const char* GetFullDocumentation()
{
return
" GET_TARGET_PROPERTY(VAR target property)\n"
" get_target_property(VAR target property)\n"
"Get a property from a target. The value of the property is "
"stored in the variable VAR. If the property is not found, VAR "
"will be set to \"NOTFOUND\". Use SET_TARGET_PROPERTIES to set "
"will be set to \"NOTFOUND\". Use set_target_properties to set "
"property values. Properties are usually used to control how "
"a target is built.\n"
"The read-only property \"<CONFIG>_LOCATION\" provides the full "

4
Source/cmGetTestPropertyCommand.h
View File

@ -36,7 +36,7 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "GET_TEST_PROPERTY";}
virtual const char* GetName() { return "get_test_property";}
/**
* Succinct documentation.
@ -52,7 +52,7 @@ public:
virtual const char* GetFullDocumentation()
{
return
" GET_TEST_PROPERTY(test VAR property)\n"
" get_test_property(test VAR property)\n"
"Get a property from the Test. The value of the property is "
"stored in the variable VAR. If the property is not found, "
"CMake will report an error. For a list of standard properties "

72
Source/cmIfCommand.h
View File

@ -73,7 +73,7 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "IF";}
virtual const char* GetName() { return "if";}
/**
* Succinct documentation.
@ -94,78 +94,78 @@ public:
virtual const char* GetFullDocumentation()
{
return
" IF(expression)\n"
" # THEN section.\n"
" if(expression)\n"
" # then section.\n"
" COMMAND1(ARGS ...)\n"
" COMMAND2(ARGS ...)\n"
" ...\n"
" ELSEIF(expression2)\n"
" # ELSEIF section.\n"
" elseif(expression2)\n"
" # elseif section.\n"
" COMMAND1(ARGS ...)\n"
" COMMAND2(ARGS ...)\n"
" ...\n"
" ELSE(expression)\n"
" # ELSE section.\n"
" else(expression)\n"
" # else section.\n"
" COMMAND1(ARGS ...)\n"
" COMMAND2(ARGS ...)\n"
" ...\n"
" ENDIF(expression)\n"
" endif(expression)\n"
"Evaluates the given expression. If the result is true, the commands "
"in the THEN section are invoked. Otherwise, the commands in the "
"ELSE section are invoked. The ELSEIF and ELSE sections are "
"optional. You may have multiple ELSEIF clauses. Note that "
"the same expression must be given to IF, and ENDIF. Long "
"else section are invoked. The elseif and else sections are "
"optional. You may have multiple elseif clauses. Note that "
"the same expression must be given to if, and endif. Long "
"expressions can be used and the order or precedence is that the "
"EXISTS, COMMAND, and DEFINED operators will be evaluated first. "
"Then any EQUAL, LESS, GREATER, STRLESS, STRGREATER, STREQUAL, MATCHES "
"will be evaluated. Then NOT operators and finally AND, OR operators "
"will be evaluated. Possible expressions are:\n"
" IF(variable)\n"
" if(variable)\n"
"True if the variable's value is not empty, 0, N, NO, OFF, FALSE, "
"NOTFOUND, or <variable>-NOTFOUND.\n"
" IF(NOT variable)\n"
" if(NOT variable)\n"
"True if the variable's value is empty, 0, N, NO, OFF, FALSE, "
"NOTFOUND, or <variable>-NOTFOUND.\n"
" IF(variable1 AND variable2)\n"
" if(variable1 AND variable2)\n"
"True if both variables would be considered true individually.\n"
" IF(variable1 OR variable2)\n"
" if(variable1 OR variable2)\n"
"True if either variable would be considered true individually.\n"
" IF(COMMAND command-name)\n"
" if(COMMAND command-name)\n"
"True if the given name is a command that can be invoked.\n"
" IF(EXISTS file-name)\n"
" IF(EXISTS directory-name)\n"
" if(EXISTS file-name)\n"
" if(EXISTS directory-name)\n"
"True if the named file or directory exists. "
"Behavior is well-defined only for full paths.\n"
" IF(file1 IS_NEWER_THAN file2)\n"
" if(file1 IS_NEWER_THAN file2)\n"
"True if file1 is newer than file2 or if one of the two files "
"doesn't exist. "
"Behavior is well-defined only for full paths.\n"
" IF(IS_DIRECTORY directory-name)\n"
" if(IS_DIRECTORY directory-name)\n"
"True if the given name is a directory. "
"Behavior is well-defined only for full paths.\n"
" IF(IS_ABSOLUTE path)\n"
" if(IS_ABSOLUTE path)\n"
"True if the given path is an absolute path.\n "
" IF(variable MATCHES regex)\n"
" IF(string MATCHES regex)\n"
" if(variable MATCHES regex)\n"
" if(string MATCHES regex)\n"
"True if the given string or variable's value matches the given "
"regular expression.\n"
" IF(variable LESS number)\n"
" IF(string LESS number)\n"
" IF(variable GREATER number)\n"
" IF(string GREATER number)\n"
" IF(variable EQUAL number)\n"
" IF(string EQUAL number)\n"
" if(variable LESS number)\n"
" if(string LESS number)\n"
" if(variable GREATER number)\n"
" if(string GREATER number)\n"
" if(variable EQUAL number)\n"
" if(string EQUAL number)\n"
"True if the given string or variable's value is a valid number and "
"the inequality or equality is true.\n"
" IF(variable STRLESS string)\n"
" IF(string STRLESS string)\n"
" IF(variable STRGREATER string)\n"
" IF(string STRGREATER string)\n"
" IF(variable STREQUAL string)\n"
" IF(string STREQUAL string)\n"
" if(variable STRLESS string)\n"
" if(string STRLESS string)\n"
" if(variable STRGREATER string)\n"
" if(string STRGREATER string)\n"
" if(variable STREQUAL string)\n"
" if(string STREQUAL string)\n"
"True if the given string or variable's value is lexicographically "
"less (or greater, or equal) than the string on the right.\n"
" IF(DEFINED variable)\n"
" if(DEFINED variable)\n"
"True if the given variable is defined. It does not matter if the "
"variable is true or false just if it has been set.";
}

8
Source/cmIncludeCommand.h
View File

@ -52,7 +52,7 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() {return "INCLUDE";}
virtual const char* GetName() {return "include";}
/**
* Succinct documentation.
@ -68,11 +68,11 @@ public:
virtual const char* GetFullDocumentation()
{
return
" INCLUDE(file1 [OPTIONAL] [RESULT_VARIABLE <VAR>])\n"
" INCLUDE(module [OPTIONAL] [RESULT_VARIABLE <VAR>])\n"
" include(file1 [OPTIONAL] [RESULT_VARIABLE <VAR>])\n"
" include(module [OPTIONAL] [RESULT_VARIABLE <VAR>])\n"
"Reads CMake listfile code from the given file. Commands in the file "
"are processed immediately as if they were written in place of the "
"INCLUDE command. If OPTIONAL is present, then no error "
"include command. If OPTIONAL is present, then no error "
"is raised if the file does not exist. If RESULT_VARIABLE is given "
"the variable will be set to the full filename which "
"has been included or NOTFOUND if it failed.\n"

6
Source/cmIncludeDirectoryCommand.h
View File

@ -45,7 +45,7 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "INCLUDE_DIRECTORIES";}
virtual const char* GetName() { return "include_directories";}
/**
* Succinct documentation.
@ -61,11 +61,11 @@ public:
virtual const char* GetFullDocumentation()
{
return
" INCLUDE_DIRECTORIES([AFTER|BEFORE] [SYSTEM] dir1 dir2 ...)\n"
" include_directories([AFTER|BEFORE] [SYSTEM] dir1 dir2 ...)\n"
"Add the given directories to those searched by the compiler for "
"include files. By default the directories are appended onto "
"the current list of directories. This default behavior can be "
"changed by setting CMAKE_INCLUDE_DIRECTORIES_BEFORE to ON. "
"changed by setting CMAKE_include_directories_BEFORE to ON. "
"By using BEFORE or AFTER you can select between appending and "
"prepending, independent from the default. "
"If the SYSTEM option is given the compiler will be told that the "

4
Source/cmIncludeExternalMSProjectCommand.h
View File

@ -46,7 +46,7 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() {return "INCLUDE_EXTERNAL_MSPROJECT";}
virtual const char* GetName() {return "include_external_msproject";}
/**
* Succinct documentation.
@ -62,7 +62,7 @@ public:
virtual const char* GetFullDocumentation()
{
return
" INCLUDE_EXTERNAL_MSPROJECT(projectname location\n"
" include_external_msproject(projectname location\n"
" dep1 dep2 ...)\n"
"Includes an external Microsoft project in the generated workspace "
"file. Currently does nothing on UNIX.";

4
Source/cmIncludeRegularExpressionCommand.h
View File

@ -45,7 +45,7 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() {return "INCLUDE_REGULAR_EXPRESSION";}
virtual const char* GetName() {return "include_regular_expression";}
/**
* Succinct documentation.
@ -61,7 +61,7 @@ public:
virtual const char* GetFullDocumentation()
{
return
" INCLUDE_REGULAR_EXPRESSION(regex_match [regex_complain])\n"
" include_regular_expression(regex_match [regex_complain])\n"
"Set the regular expressions used in dependency checking. Only files "
"matching regex_match will be traced as dependencies. Only files "
"matching regex_complain will generate warnings if they cannot be "

20
Source/cmInstallCommand.h
View File

@ -45,7 +45,7 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "INSTALL";}
virtual const char* GetName() { return "install";}
/**
* Succinct documentation.
@ -97,7 +97,7 @@ public:
"file to be installed does not exist. "
"\n"
"The TARGETS signature:\n"
" INSTALL(TARGETS targets...\n"
" install(TARGETS targets...\n"
" [[ARCHIVE|LIBRARY|RUNTIME]\n"
" [DESTINATION <dir>]\n"
" [PERMISSIONS permissions...]\n"
@ -130,11 +130,11 @@ public:
"to the TARGETS form of this command. A target may be installed more "
"than once to different locations. Consider hypothetical "
"targets \"myExe\", \"mySharedLib\", and \"myStaticLib\". The code\n"
" INSTALL(TARGETS myExe mySharedLib myStaticLib\n"
" install(TARGETS myExe mySharedLib myStaticLib\n"
" RUNTIME DESTINATION bin\n"
" LIBRARY DESTINATION lib\n"
" ARCHIVE DESTINATION lib/static)\n"
" INSTALL(TARGETS mySharedLib DESTINATION /some/full/path)\n"
" install(TARGETS mySharedLib DESTINATION /some/full/path)\n"
"will install myExe to <prefix>/bin and myStaticLib to "
"<prefix>/lib/static. "
"On non-DLL platforms mySharedLib will be installed to <prefix>/lib "
@ -148,7 +148,7 @@ public:
"undefined behavior."
"\n"
"The FILES signature:\n"
" INSTALL(FILES files... DESTINATION <dir>\n"
" install(FILES files... DESTINATION <dir>\n"
" [PERMISSIONS permissions...]\n"
" [CONFIGURATIONS [Debug|Release|...]]\n"
" [COMPONENT <component>]\n"
@ -160,7 +160,7 @@ public:
"GROUP_READ, and WORLD_READ if no PERMISSIONS argument is given."
"\n"
"The PROGRAMS signature:\n"
" INSTALL(PROGRAMS files... DESTINATION <dir>\n"
" install(PROGRAMS files... DESTINATION <dir>\n"
" [PERMISSIONS permissions...]\n"
" [CONFIGURATIONS [Debug|Release|...]]\n"
" [COMPONENT <component>]\n"
@ -173,7 +173,7 @@ public:
"built within the project."
"\n"
"The DIRECTORY signature:\n"
" INSTALL(DIRECTORY dirs... DESTINATION <dir>\n"
" install(DIRECTORY dirs... DESTINATION <dir>\n"
" [FILE_PERMISSIONS permissions...]\n"
" [DIRECTORY_PERMISSIONS permissions...]\n"
" [USE_SOURCE_PERMISSIONS]\n"
@ -214,7 +214,7 @@ public:
"The PERMISSIONS option overrides the permissions setting for the "
"matched file or directory. "
"For example the code\n"
" INSTALL(DIRECTORY icons scripts/ DESTINATION share/myproj\n"
" install(DIRECTORY icons scripts/ DESTINATION share/myproj\n"
" PATTERN \"CVS\" EXCLUDE\n"
" PATTERN \"scripts/*\"\n"
" PERMISSIONS OWNER_EXECUTE OWNER_WRITE OWNER_READ\n"
@ -225,14 +225,14 @@ public:
"any CVS directories will be excluded."
"\n"
"The SCRIPT and CODE signature:\n"
" INSTALL([[SCRIPT <file>] [CODE <code>]] [...])\n"
" install([[SCRIPT <file>] [CODE <code>]] [...])\n"
"The SCRIPT form will invoke the given CMake script files during "
"installation. If the script file name is a relative path "
"it will be interpreted with respect to the current source directory. "
"The CODE form will invoke the given CMake code during installation. "
"Code is specified as a single argument inside a double-quoted string. "
"For example, the code\n"
" INSTALL(CODE \"MESSAGE(\\\"Sample install message.\\\")\")\n"
" install(CODE \"MESSAGE(\\\"Sample install message.\\\")\")\n"
"will print a message during installation.\n"
"NOTE: This command supercedes the INSTALL_TARGETS command and the "
"target properties PRE_INSTALL_SCRIPT and POST_INSTALL_SCRIPT. "

16
Source/cmInstallFilesCommand.h
View File

@ -45,14 +45,14 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "INSTALL_FILES";}
virtual const char* GetName() { return "install_files";}
/**
* Succinct documentation.
*/
virtual const char* GetTerseDocumentation()
{
return "Deprecated. Use the INSTALL(FILES ) command instead.";
return "Deprecated. Use the install(FILES ) command instead.";
}
/**
@ -69,12 +69,12 @@ public:
virtual const char* GetFullDocumentation()
{
return
"This command has been superceded by the INSTALL command. It "
"This command has been superceded by the install command. It "
"is provided for compatibility with older CMake code. "
"The FILES form is directly replaced by the FILES form of the "
"INSTALL command. The regexp form can be expressed "
"more clearly using the GLOB form of the FILE command.\n"
" INSTALL_FILES(<dir> extension file file ...)\n"
"install command. The regexp form can be expressed "
"more clearly using the GLOB form of the file command.\n"
" install_files(<dir> extension file file ...)\n"
"Create rules to install the listed files with the given extension "
"into the given directory. "
"Only files existing in the current source tree or its corresponding "
@ -83,10 +83,10 @@ public:
"removed first. This is useful for providing lists of source files "
"such as foo.cxx when you want the corresponding foo.h to be "
"installed. A typical extension is '.h'.\n"
" INSTALL_FILES(<dir> regexp)\n"
" install_files(<dir> regexp)\n"
"Any files in the current source directory that match the regular "
"expression will be installed.\n"
" INSTALL_FILES(<dir> FILES file file ...)\n"
" install_files(<dir> FILES file file ...)\n"
"Any files listed after the FILES keyword will be "
"installed explicitly from the names given. Full paths are allowed in "
"this form.\n"

12
Source/cmInstallProgramsCommand.h
View File

@ -45,14 +45,14 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "INSTALL_PROGRAMS";}
virtual const char* GetName() { return "install_programs";}
/**
* Succinct documentation.
*/
virtual const char* GetTerseDocumentation()
{
return "Deprecated. Use the INSTALL(PROGRAMS ) command instead.";
return "Deprecated. Use the install(PROGRAMS ) command instead.";
}
/**
@ -69,17 +69,17 @@ public:
virtual const char* GetFullDocumentation()
{
return
"This command has been superceded by the INSTALL command. It "
"This command has been superceded by the install command. It "
"is provided for compatibility with older CMake code. "
"The FILES form is directly replaced by the PROGRAMS form of the "
"INSTALL command. The regexp form can be expressed more clearly "
"using the GLOB form of the FILE command.\n"
" INSTALL_PROGRAMS(<dir> file1 file2 [file3 ...])\n"
" INSTALL_PROGRAMS(<dir> FILES file1 [file2 ...])\n"
" install_programs(<dir> file1 file2 [file3 ...])\n"
" install_programs(<dir> FILES file1 [file2 ...])\n"
"Create rules to install the listed programs into the given directory. "
"Use the FILES argument to guarantee that the file list version of "
"the command will be used even when there is only one argument.\n"
" INSTALL_PROGRAMS(<dir> regexp)\n"
" install_programs(<dir> regexp)\n"
"In the second form any program in the current source directory that "
"matches the regular expression will be installed.\n"
"This command is intended to install programs that are not built "

8
Source/cmInstallTargetsCommand.h
View File

@ -46,14 +46,14 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "INSTALL_TARGETS";}
virtual const char* GetName() { return "install_targets";}
/**
* Succinct documentation.
*/
virtual const char* GetTerseDocumentation()
{
return "Deprecated. Use the INSTALL(TARGETS ) command instead.";
return "Deprecated. Use the install(TARGETS ) command instead.";
}
/**
@ -62,9 +62,9 @@ public:
virtual const char* GetFullDocumentation()
{
return
"This command has been superceded by the INSTALL command. It "
"This command has been superceded by the install command. It "
"is provided for compatibility with older CMake code.\n"
" INSTALL_TARGETS(<dir> [RUNTIME_DIRECTORY dir] target target)\n"
" install_targets(<dir> [RUNTIME_DIRECTORY dir] target target)\n"
"Create rules to install the listed targets into the given directory. "
"The directory <dir> is relative to the installation prefix, which "
"is stored in the variable CMAKE_INSTALL_PREFIX. If RUNTIME_DIRECTORY "

4
Source/cmLinkDirectoriesCommand.h
View File

@ -47,7 +47,7 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "LINK_DIRECTORIES";}
virtual const char* GetName() { return "link_directories";}
/**
* Succinct documentation.
@ -63,7 +63,7 @@ public:
virtual const char* GetFullDocumentation()
{
return
" LINK_DIRECTORIES(directory1 directory2 ...)\n"
" link_directories(directory1 directory2 ...)\n"
"Specify the paths in which the linker should search for libraries.";
}

10
Source/cmLinkLibrariesCommand.h
View File

@ -46,14 +46,14 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "LINK_LIBRARIES";}
virtual const char* GetName() { return "link_libraries";}
/**
* Succinct documentation.
*/
virtual const char* GetTerseDocumentation()
{
return "Deprecated. Use the TARGET_LINK_LIBRARIES() command instead.";
return "Deprecated. Use the target_link_libraries() command instead.";
}
/**
@ -63,10 +63,10 @@ public:
{
return
"Link libraries to all targets added later.\n"
" LINK_LIBRARIES(library1 <debug | optimized> library2 ...)\n"
" link_libraries(library1 <debug | optimized> library2 ...)\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 "
"any following targets (typically added with the add_executable "
"or add_library calls). This command is passed "
"down to all subdirectories. "
"The debug and optimized strings may be used to indicate that "
"the next library listed is to be used only for that specific "

20
Source/cmListCommand.h
View File

@ -48,7 +48,7 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "LIST";}
virtual const char* GetName() { return "list";}
/**
* Succinct documentation.
@ -64,16 +64,16 @@ public:
virtual const char* GetFullDocumentation()
{
return
" LIST(LENGTH <list> <output variable>)\n"
" LIST(GET <list> <element index> [<element index> ...] "
" list(LENGTH <list> <output variable>)\n"
" list(GET <list> <element index> [<element index> ...] "
"<output variable>)\n"
" LIST(APPEND <list> <element> [<element> ...])\n"
" LIST(FIND <list> <value> <output variable>)\n"
" LIST(INSERT <list> <element_index> <element> [<element> ...])\n"
" LIST(REMOVE_ITEM <list> <value> [<value> ...])\n"
" LIST(REMOVE_AT <list> <index> [<index> ...])\n"
" LIST(REVERSE <list>)\n"
" LIST(SORT <list>)\n"
" list(APPEND <list> <element> [<element> ...])\n"
" list(FIND <list> <value> <output variable>)\n"
" list(INSERT <list> <element_index> <element> [<element> ...])\n"
" list(REMOVE_ITEM <list> <value> [<value> ...])\n"
" list(REMOVE_AT <list> <index> [<index> ...])\n"
" list(REVERSE <list>)\n"
" list(SORT <list>)\n"
"LENGTH will return a given list's length.\n"
"GET will return list of elements specified by indices from the list.\n"
"APPEND will append elements to the list.\n"

6
Source/cmLoadCacheCommand.h
View File

@ -44,7 +44,7 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "LOAD_CACHE";}
virtual const char* GetName() { return "load_cache";}
/**
* Succinct documentation.
@ -60,13 +60,13 @@ public:
virtual const char* GetFullDocumentation()
{
return
" LOAD_CACHE(pathToCacheFile READ_WITH_PREFIX\n"
" load_cache(pathToCacheFile READ_WITH_PREFIX\n"
" prefix entry1...)\n"
"Read the cache and store the requested entries in variables with "
"their name prefixed with the given prefix. "
"This only reads the values, and does not create entries in the local "
"project's cache.\n"
" LOAD_CACHE(pathToCacheFile [EXCLUDE entry1...]\n"
" load_cache(pathToCacheFile [EXCLUDE entry1...]\n"
" [INCLUDE_INTERNALS entry1...])\n"
"Load in the values from another cache and store them in the local "
"project's cache as internal entries. This is useful for a project "

4
Source/cmLoadCommandCommand.h
View File

@ -44,7 +44,7 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() {return "LOAD_COMMAND";}
virtual const char* GetName() {return "load_command";}
/**
* Succinct documentation.
@ -60,7 +60,7 @@ public:
virtual const char* GetFullDocumentation()
{
return
" LOAD_COMMAND(COMMAND_NAME <loc1> [loc2 ...])\n"
" load_command(COMMAND_NAME <loc1> [loc2 ...])\n"
"The given locations are searched for a library whose name is "
"cmCOMMAND_NAME. If found, it is loaded as a module and the command "
"is added to the set of available CMake commands. Usually, "

10
Source/cmMacroCommand.h
View File

@ -69,7 +69,7 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "MACRO";}
virtual const char* GetName() { return "macro";}
/**
* Succinct documentation.
@ -85,14 +85,14 @@ public:
virtual const char* GetFullDocumentation()
{
return
" MACRO(<name> [arg1 [arg2 [arg3 ...]]])\n"
" macro(<name> [arg1 [arg2 [arg3 ...]]])\n"
" COMMAND1(ARGS ...)\n"
" COMMAND2(ARGS ...)\n"
" ...\n"
" ENDMACRO(<name>)\n"
" endmacro(<name>)\n"
"Define a macro named <name> that takes arguments named "
"arg1 arg2 arg3 (...). Commands listed after MACRO, "
"but before the matching ENDMACRO, are not invoked until the macro "
"arg1 arg2 arg3 (...). Commands listed after macro, "
"but before the matching endmacro, are not invoked until the macro "
"is invoked. When it is invoked, the commands recorded in the "
"macro are first modified by replacing formal parameters (${arg1}) "
"with the arguments passed, and then invoked as normal commands. In "

6
Source/cmMakeDirectoryCommand.h
View File

@ -48,7 +48,7 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "MAKE_DIRECTORY";}
virtual const char* GetName() { return "make_directory";}
/**
* This determines if the command is invoked when in script mode.
@ -60,7 +60,7 @@ public:
*/
virtual const char* GetTerseDocumentation()
{
return "Deprecated. Use the FILE(MAKE_DIRECTORY ) command instead.";
return "Deprecated. Use the file(MAKE_DIRECTORY ) command instead.";
}
/**
@ -69,7 +69,7 @@ public:
virtual const char* GetFullDocumentation()
{
return
" MAKE_DIRECTORY(directory)\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.";

6
Source/cmMarkAsAdvancedCommand.h
View File

@ -44,7 +44,7 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() {return "MARK_AS_ADVANCED";}
virtual const char* GetName() {return "mark_as_advanced";}
/**
* Succinct documentation.
@ -60,7 +60,7 @@ public:
virtual const char* GetFullDocumentation()
{
return
" MARK_AS_ADVANCED([CLEAR|FORCE] VAR VAR2 VAR...)\n"
" mark_as_advanced([CLEAR|FORCE] VAR VAR2 VAR...)\n"
"Mark the named cached variables as advanced. An advanced variable "
"will not be displayed in any of the cmake GUIs unless the show "
"advanced option is on. "
@ -75,7 +75,7 @@ public:
/**
* This determines if the command is invoked when in script mode.
* MARK_AS_ADVANCED() will have no effect in script mode, but this will
* mark_as_advanced() will have no effect in script mode, but this will
* make many of the modules usable in cmake/ctest scripts, (among them
* FindUnixMake.cmake used by the CTEST_BUILD command.
*/

4
Source/cmMathCommand.h
View File

@ -48,7 +48,7 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "MATH";}
virtual const char* GetName() { return "math";}
/**
* Succinct documentation.
@ -64,7 +64,7 @@ public:
virtual const char* GetFullDocumentation()
{
return
" MATH(EXPR <output variable> <math expression>)\n"
" math(EXPR <output variable> <math expression>)\n"
"EXPR evaluates mathematical expression and return result in the "
"output variable. Example mathematical expression is "
"'5 * ( 10 + 13 )'. Supported operators are "

4
Source/cmMessageCommand.h
View File

@ -43,7 +43,7 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "MESSAGE";}
virtual const char* GetName() { return "message";}
/**
* This determines if the command is invoked when in script mode.
@ -64,7 +64,7 @@ public:
virtual const char* GetFullDocumentation()
{
return
" MESSAGE([SEND_ERROR | STATUS | FATAL_ERROR]\n"
" message([SEND_ERROR | STATUS | FATAL_ERROR]\n"
" \"message to display\" ...)\n"
"By default the message is displayed in a pop up window (CMakeSetup), "
"or in the stdout of cmake, or the error section of ccmake. "

4
Source/cmOptionCommand.h
View File

@ -44,7 +44,7 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() {return "OPTION";}
virtual const char* GetName() {return "option";}
/**
* Succinct documentation.
@ -60,7 +60,7 @@ public:
virtual const char* GetFullDocumentation()
{
return
" OPTION(OPTION_VAR \"help string describing option\"\n"
" option(OPTION_VAR \"help string describing option\"\n"
" [initial value])\n"
"Provide an option for the user to select as ON or OFF. If no "
"initial value is provided, OFF is used.";

4
Source/cmOutputRequiredFilesCommand.h
View File

@ -46,7 +46,7 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "OUTPUT_REQUIRED_FILES";}
virtual const char* GetName() { return "output_required_files";}
/**
* Succinct documentation.
@ -63,7 +63,7 @@ public:
virtual const char* GetFullDocumentation()
{
return
" OUTPUT_REQUIRED_FILES(srcfile outputfile)\n"
" output_required_files(srcfile outputfile)\n"
"Outputs a list of all the source files that are required by the "
"specified srcfile. This list is written into outputfile. This is "
"similar to writing out the dependencies for srcfile except that it "

4
Source/cmProjectCommand.h
View File

@ -47,7 +47,7 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() {return "PROJECT";}
virtual const char* GetName() {return "project";}
/**
* Succinct documentation.
@ -63,7 +63,7 @@ public:
virtual const char* GetFullDocumentation()
{
return
" PROJECT(projectname [CXX] [C] [Java])\n"
" project(projectname [CXX] [C] [Java])\n"
"Sets the name of the project. "
"This creates the variables projectname_BINARY_DIR and "
"projectname_SOURCE_DIR. "

4
Source/cmQTWrapCPPCommand.h
View File

@ -49,7 +49,7 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "QT_WRAP_CPP";}
virtual const char* GetName() { return "qt_wrap_cpp";}
/**
* Succinct documentation.
@ -65,7 +65,7 @@ public:
virtual const char* GetFullDocumentation()
{
return
" QT_WRAP_CPP(resultingLibraryName DestName\n"
" qt_wrap_cpp(resultingLibraryName DestName\n"
" SourceLists ...)\n"
"Produce moc files for all the .h files listed in the SourceLists. "
"The moc files will be added to the library using the DestName "

4
Source/cmQTWrapUICommand.h
View File

@ -47,7 +47,7 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "QT_WRAP_UI";}
virtual const char* GetName() { return "qt_wrap_ui";}
/**
* Succinct documentation.
@ -63,7 +63,7 @@ public:
virtual const char* GetFullDocumentation()
{
return
" QT_WRAP_UI(resultingLibraryName HeadersDestName\n"
" qt_wrap_ui(resultingLibraryName HeadersDestName\n"
" SourcesDestName SourceLists ...)\n"
"Produce .h and .cxx files for all the .ui files listed "
"in the SourceLists. "

6
Source/cmRemoveCommand.h
View File

@ -49,14 +49,14 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() {return "REMOVE";}
virtual const char* GetName() {return "remove";}
/**
* Succinct documentation.
*/
virtual const char* GetTerseDocumentation()
{
return "Deprecated. Use the LIST(REMOVE_ITEM ) command instead.";
return "Deprecated. Use the list(REMOVE_ITEM ) command instead.";
}
/**
@ -65,7 +65,7 @@ public:
virtual const char* GetFullDocumentation()
{
return
" REMOVE(VAR VALUE VALUE ...)\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.";

4
Source/cmRemoveDefinitionsCommand.h
View File

@ -46,7 +46,7 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() {return "REMOVE_DEFINITIONS";}
virtual const char* GetName() {return "remove_definitions";}
/**
* Succinct documentation.
@ -63,7 +63,7 @@ public:
virtual const char* GetFullDocumentation()
{
return
" REMOVE_DEFINITIONS(-DFOO -DBAR ...)\n"
" remove_definitions(-DFOO -DBAR ...)\n"
"Removes flags from command line of C and C++ compilers. "
"This command can be used to remove any flag from a compile line, "
"but the -D flag is accepted by most C/C++ compilers. "

4
Source/cmSeparateArgumentsCommand.h
View File

@ -49,7 +49,7 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() {return "SEPARATE_ARGUMENTS";}
virtual const char* GetName() {return "separate_arguments";}
/**
* Succinct documentation.
@ -66,7 +66,7 @@ public:
virtual const char* GetFullDocumentation()
{
return
" SEPARATE_ARGUMENTS(VARIABLE)\n"
" separate_arguments(VARIABLE)\n"
"Convert the value of VARIABLE to a semi-colon separated list. "
"All spaces are replaced with ';'. This helps with generating "
"command lines.";

8
Source/cmSetCommand.h
View File

@ -49,7 +49,7 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() {return "SET";}
virtual const char* GetName() {return "set";}
/**
* Succinct documentation.
@ -65,7 +65,7 @@ public:
virtual const char* GetFullDocumentation()
{
return
" SET(VAR [VALUE] [CACHE TYPE DOCSTRING [FORCE]])\n"
" set(VAR [VALUE] [CACHE TYPE DOCSTRING [FORCE]])\n"
"Within CMake sets VAR to the value VALUE. VALUE is expanded before "
"VAR is set to it. If CACHE is present, then the VAR is put in the "
"cache. TYPE and DOCSTRING are required. TYPE is used by the CMake GUI "
@ -81,10 +81,10 @@ public:
"variable, then this always writes into the current makefile. The "
"FORCE option will overwrite the cache value removing any changes by "
"the user.\n"
" SET(VAR VALUE1 ... VALUEN).\n"
" set(VAR VALUE1 ... VALUEN).\n"
"In this case VAR is set to a semicolon separated list of values.\n"
"VAR can be an environment variable such as:\n"
" SET( ENV{PATH} /home/martink )\n"
" set( ENV{PATH} /home/martink )\n"
"in which case the environment variable will be set.";
}

4
Source/cmSetDirectoryPropertiesCommand.h
View File

@ -41,7 +41,7 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "SET_DIRECTORY_PROPERTIES";}
virtual const char* GetName() { return "set_directory_properties";}
/**
* Succinct documentation.
@ -65,7 +65,7 @@ public:
virtual const char* GetFullDocumentation()
{
return
" SET_DIRECTORY_PROPERTIES(PROPERTIES prop1 value1 prop2 value2)\n"
" set_directory_properties(PROPERTIES prop1 value1 prop2 value2)\n"
"Set a property for the current directory and subdirectories. If the "
"property is not found, CMake will report an error. The properties "
"include: INCLUDE_DIRECTORIES, LINK_DIRECTORIES, "

4
Source/cmSetPropertiesCommand.h
View File

@ -36,7 +36,7 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "SET_PROPERTIES";}
virtual const char* GetName() { return "set_properties";}
/**
* Succinct documentation.
@ -52,7 +52,7 @@ public:
virtual const char* GetFullDocumentation()
{
return
" SET_PROPERTIES(scope_value\n"
" set_properties(scope_value\n"
" PROPERTIES prop1 value1\n"
" prop2 value2 ...)\n"
"Set properties on something. The scope_value is either GLOBAL, "

4
Source/cmSetSourceFilesPropertiesCommand.h
View File

@ -36,7 +36,7 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "SET_SOURCE_FILES_PROPERTIES";}
virtual const char* GetName() { return "set_source_files_properties";}
/**
* Succinct documentation.
@ -52,7 +52,7 @@ public:
virtual const char* GetFullDocumentation()
{
return
" SET_SOURCE_FILES_PROPERTIES(file1 file2 ...\n"
" set_source_files_properties(file1 file2 ...\n"
" PROPERTIES prop1 value1\n"
" prop2 value2 ...)\n"
"Set properties on a file. The syntax for the command is to list all "

4
Source/cmSetTargetPropertiesCommand.h
View File

@ -36,7 +36,7 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "SET_TARGET_PROPERTIES";}
virtual const char* GetName() { return "set_target_properties";}
/**
* Succinct documentation.
@ -59,7 +59,7 @@ public:
virtual const char* GetFullDocumentation()
{
return
" SET_TARGET_PROPERTIES(target1 target2 ...\n"
" set_target_properties(target1 target2 ...\n"
" PROPERTIES prop1 value1\n"
" prop2 value2 ...)\n"
"Set properties on a target. The syntax for the command is to "

4
Source/cmSetTestsPropertiesCommand.h
View File

@ -36,7 +36,7 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "SET_TESTS_PROPERTIES";}
virtual const char* GetName() { return "set_tests_properties";}
/**
* Succinct documentation.
@ -52,7 +52,7 @@ public:
virtual const char* GetFullDocumentation()
{
return
" SET_TESTS_PROPERTIES(test1 [test2...] PROPERTIES prop1 value1 prop2"
" set_tests_properties(test1 [test2...] PROPERTIES prop1 value1 prop2"
" value2)\n"
"Set a property for the tests. If the property is not found, CMake "
"will report an error. The properties include:\n"

4
Source/cmSiteNameCommand.h
View File

@ -49,7 +49,7 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() {return "SITE_NAME";}
virtual const char* GetName() {return "site_name";}
/**
* Succinct documentation.
@ -65,7 +65,7 @@ public:
virtual const char* GetFullDocumentation()
{
return
" SITE_NAME(variable)\n";
" site_name(variable)\n";
}
cmTypeMacro(cmSiteNameCommand, cmCommand);

8
Source/cmSourceGroupCommand.h
View File

@ -45,7 +45,7 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() {return "SOURCE_GROUP";}
virtual const char* GetName() {return "source_group";}
/**
* Succinct documentation.
@ -61,7 +61,7 @@ public:
virtual const char* GetFullDocumentation()
{
return
" SOURCE_GROUP(name [REGULAR_EXPRESSION regex] "
" source_group(name [REGULAR_EXPRESSION regex] "
"[FILES src1 src2 ...])\n"
"Defines a group into which sources will be placed in project files. "
"This is mainly used to setup file tabs in Visual Studio. "
@ -71,10 +71,10 @@ public:
"group explicitly lists the file, the LAST group whose regular "
"expression matches the file will be favored.\n"
"The name of the group may contain backslashes to specify subgroups:\n"
" SOURCE_GROUP(outer\\\\inner ...)\n"
" source_group(outer\\\\inner ...)\n"
"For backwards compatibility, this command is also supports the "
"format:\n"
" SOURCE_GROUP(name regex)";
" source_group(name regex)";
}
cmTypeMacro(cmSourceGroupCommand, cmCommand);

34
Source/cmStringCommand.h
View File

@ -54,7 +54,7 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "STRING";}
virtual const char* GetName() { return "string";}
/**
* Succinct documentation.
@ -70,29 +70,29 @@ public:
virtual const char* GetFullDocumentation()
{
return
" STRING(REGEX MATCH <regular_expression>\n"
" string(REGEX MATCH <regular_expression>\n"
" <output variable> <input> [<input>...])\n"
" STRING(REGEX MATCHALL <regular_expression>\n"
" string(REGEX MATCHALL <regular_expression>\n"
" <output variable> <input> [<input>...])\n"
" STRING(REGEX REPLACE <regular_expression>\n"
" string(REGEX REPLACE <regular_expression>\n"
" <replace_expression> <output variable>\n"
" <input> [<input>...])\n"
" STRING(REPLACE <match_string>\n"
" string(REPLACE <match_string>\n"
" <replace_string> <output variable>\n"
" <input> [<input>...])\n"
" STRING(COMPARE EQUAL <string1> <string2> <output variable>)\n"
" STRING(COMPARE NOTEQUAL <string1> <string2> <output variable>)\n"
" STRING(COMPARE LESS <string1> <string2> <output variable>)\n"
" STRING(COMPARE GREATER <string1> <string2> <output variable>)\n"
" STRING(ASCII <number> [<number> ...] <output variable>)\n"
" STRING(CONFIGURE <string1> <output variable>\n"
" string(COMPARE EQUAL <string1> <string2> <output variable>)\n"
" string(COMPARE NOTEQUAL <string1> <string2> <output variable>)\n"
" string(COMPARE LESS <string1> <string2> <output variable>)\n"
" string(COMPARE GREATER <string1> <string2> <output variable>)\n"
" string(ASCII <number> [<number> ...] <output variable>)\n"
" string(CONFIGURE <string1> <output variable>\n"
" [@ONLY] [ESCAPE_QUOTES])\n"
" STRING(TOUPPER <string1> <output variable>)\n"
" STRING(TOLOWER <string1> <output variable>)\n"
" STRING(LENGTH <string> <output variable>)\n"
" STRING(SUBSTRING <string> <begin> <length> <output variable>)\n"
" STRING(STRIP <string> <output variable>)\n"
" STRING(RANDOM [LENGTH <length>] [ALPHABET <alphabet>]\n"
" string(TOUPPER <string1> <output variable>)\n"
" string(TOLOWER <string1> <output variable>)\n"
" string(LENGTH <string> <output variable>)\n"
" string(SUBSTRING <string> <begin> <length> <output variable>)\n"
" string(STRIP <string> <output variable>)\n"
" string(RANDOM [LENGTH <length>] [ALPHABET <alphabet>]\n"
" <output variable>)\n"
"REGEX MATCH will match the regular expression once and store the "
"match in the output variable.\n"

10
Source/cmSubdirCommand.h
View File

@ -46,14 +46,14 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "SUBDIRS";}
virtual const char* GetName() { return "subdirs";}
/**
* Succinct documentation.
*/
virtual const char* GetTerseDocumentation()
{
return "Deprecated. Use the ADD_SUBDIRECTORY() command instead.";
return "Deprecated. Use the add_subdirectory() command instead.";
}
/**
@ -63,10 +63,10 @@ public:
{
return
"Add a list of subdirectories to the build.\n"
" SUBDIRS(dir1 dir2 ..."
" subdirs(dir1 dir2 ..."
"[EXCLUDE_FROM_ALL exclude_dir1 exclude_dir2 ...] [PREORDER] )\n"
"Add a list of subdirectories to the build. The ADD_SUBDIRECTORY "
"command should be used instead of SUBDIRS although SUBDIRS will "
"Add a list of subdirectories to the build. The add_subdirectory "
"command should be used instead of subdirs although subdirs will "
"still work. "
"This will cause any CMakeLists.txt files in the sub directories "
"to be processed by CMake. Any directories after the PREORDER flag "

4
Source/cmSubdirDependsCommand.h
View File

@ -46,7 +46,7 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "SUBDIR_DEPENDS";}
virtual const char* GetName() { return "subdir_depends";}
/**
* Succinct documentation.
@ -62,7 +62,7 @@ public:
virtual const char* GetFullDocumentation()
{
return
" SUBDIR_DEPENDS(subdir dep1 dep2 ...)\n"
" subdir_depends(subdir dep1 dep2 ...)\n"
"Does not do anything. This command used to help projects order "
"parallel builds correctly. This functionality is now automatic.";
}

4
Source/cmTargetLinkLibrariesCommand.h
View File

@ -46,7 +46,7 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "TARGET_LINK_LIBRARIES";}
virtual const char* GetName() { return "target_link_libraries";}
/**
* Succinct documentation.
@ -63,7 +63,7 @@ public:
virtual const char* GetFullDocumentation()
{
return
" TARGET_LINK_LIBRARIES(target library1\n"
" target_link_libraries(target library1\n"
" <debug | optimized | general> library2\n"
" ...)\n"
"Specify a list of libraries to be linked into the specified target. "

18
Source/cmTryCompileCommand.h
View File

@ -44,7 +44,7 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "TRY_COMPILE";}
virtual const char* GetName() { return "try_compile";}
/**
* Succinct documentation.
@ -59,7 +59,7 @@ public:
virtual const char* GetFullDocumentation()
{
return
" TRY_COMPILE(RESULT_VAR bindir srcdir\n"
" try_compile(RESULT_VAR bindir srcdir\n"
" projectName <targetname> [CMAKE_FLAGS <Flags>]\n"
" [OUTPUT_VARIABLE var])\n"
"Try compiling a program. In this form, srcdir should contain a "
@ -67,7 +67,7 @@ public:
"bindir and srcdir will not be deleted after this command is run. "
"If <target name> is specified then build just that target "
"otherwise the all or ALL_BUILD target is built.\n"
" TRY_COMPILE(RESULT_VAR bindir srcfile\n"
" try_compile(RESULT_VAR bindir srcfile\n"
" [CMAKE_FLAGS <Flags>]\n"
" [COMPILE_DEFINITIONS <flags> ...]\n"
" [OUTPUT_VARIABLE var]\n"
@ -84,14 +84,14 @@ public:
"COMPILE_DEFINITIONS are -Ddefinition that will be passed to the "
"compile line. "
"TRY_COMPILE creates a CMakeList.txt "
"try_compile creates a CMakeList.txt "
"file on the fly that looks like this:\n"
" ADD_DEFINITIONS( <expanded COMPILE_DEFINITIONS from calling "
" add_definitions( <expanded COMPILE_DEFINITIONS from calling "
"cmake>)\n"
" INCLUDE_DIRECTORIES(${INCLUDE_DIRECTORIES})\n"
" LINK_DIRECTORIES(${LINK_DIRECTORIES})\n"
" ADD_EXECUTABLE(cmTryCompileExec sources)\n"
" TARGET_LINK_LIBRARIES(cmTryCompileExec ${LINK_LIBRARIES})\n"
" include_directories(${INCLUDE_DIRECTORIES})\n"
" link_directories(${LINK_DIRECTORIES})\n"
" add_executable(cmTryCompileExec sources)\n"
" target_link_libraries(cmTryCompileExec ${LINK_LIBRARIES})\n"
"In both versions of the command, "
"if OUTPUT_VARIABLE is specified, then the "
"output from the build process is stored in the given variable. "

12
Source/cmTryRunCommand.h
View File

@ -44,7 +44,7 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "TRY_RUN";}
virtual const char* GetName() { return "try_run";}
/**
* Succinct documentation.
@ -60,7 +60,7 @@ public:
virtual const char* GetFullDocumentation()
{
return
" TRY_RUN(RUN_RESULT_VAR COMPILE_RESULT_VAR\n"
" try_run(RUN_RESULT_VAR COMPILE_RESULT_VAR\n"
" bindir srcfile [CMAKE_FLAGS <Flags>]\n"
" [COMPILE_DEFINITIONS <flags>]\n"
" [COMPILE_OUTPUT_VARIABLE comp]\n"
@ -79,7 +79,7 @@ public:
"gives you the output from the compile and run step combined.\n\n"
"Cross compiling issues\n"
"When cross compiling, the executable compiled in the first step "
"usually cannot be run on the build host. TRY_RUN() checks the "
"usually cannot be run on the build host. try_run() checks the "
"CMAKE_CROSSCOMPILING variable to detect whether CMake is in "
"crosscompiling mode. If that's the case, it will still try to compile "
"the executable, but it will not try to run the executable. Instead it "
@ -91,12 +91,12 @@ public:
"additional cache variable "
"RUN_RESULT_VAR__COMPILE_RESULT_VAR__TRYRUN_OUTPUT."
"This is intended to hold stdout and stderr from the executable.\n"
"In order to make cross compiling your project easier, use TRY_RUN "
"only if really required. If you use TRY_RUN, use RUN_OUTPUT_VARIABLE "
"In order to make cross compiling your project easier, use try_run "
"only if really required. If you use try_run, use RUN_OUTPUT_VARIABLE "
"(or OUTPUT_VARIABLE) only if really required. Using them will require "
"that when crosscompiling, the cache variables will have to be set "
"manually to the output of the executable. You can also \"guard\" the "
"calls to TRY_RUN with IF(CMAKE_CROSSCOMPILING) and provide an "
"calls to try_run with if(CMAKE_CROSSCOMPILING) and provide an "
"easy-to-preset alternative for this case.\n";
}

4
Source/cmUseMangledMesaCommand.h
View File

@ -49,7 +49,7 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "USE_MANGLED_MESA";}
virtual const char* GetName() { return "use_mangled_mesa";}
/**
* Succinct documentation.
@ -65,7 +65,7 @@ public:
virtual const char* GetFullDocumentation()
{
return
" USE_MANGLED_MESA(PATH_TO_MESA OUTPUT_DIRECTORY)\n"
" use_mangled_mesa(PATH_TO_MESA OUTPUT_DIRECTORY)\n"
"The path to mesa includes, should contain gl_mangle.h. "
"The mesa headers are copied to the specified output directory. "
"This allows mangled mesa headers to override other GL headers by "

6
Source/cmUtilitySourceCommand.h
View File

@ -48,7 +48,7 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "UTILITY_SOURCE";}
virtual const char* GetName() { return "utility_source";}
/**
* Succinct documentation.
@ -64,14 +64,14 @@ public:
virtual const char* GetFullDocumentation()
{
return
" UTILITY_SOURCE(cache_entry executable_name\n"
" utility_source(cache_entry executable_name\n"
" path_to_source [file1 file2 ...])\n"
"When a third-party utility's source is included in the distribution, "
"this command specifies its location and name. The cache entry will "
"not be set unless the path_to_source and all listed files exist. It "
"is assumed that the source tree of the utility will have been built "
"before it is needed.\n"
"When cross compiling CMake will print a warning if a UTILITY_SOURCE() "
"When cross compiling CMake will print a warning if a utility_source() "
"command is executed, because in many cases it is used to build an "
"executable which is executed later on. This doesn't work when "
"cross compiling, since the executable can run only on their target "

6
Source/cmVariableRequiresCommand.h
View File

@ -43,14 +43,14 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "VARIABLE_REQUIRES";}
virtual const char* GetName() { return "variable_requires";}
/**
* Succinct documentation.
*/
virtual const char* GetTerseDocumentation()
{
return "Deprecated. Use the IF() command instead.";
return "Deprecated. Use the if() command instead.";
}
/**
@ -60,7 +60,7 @@ public:
{
return
"Assert satisfaction of an option's required variables.\n"
" VARIABLE_REQUIRES(TEST_VARIABLE RESULT_VARIABLE\n"
" variable_requires(TEST_VARIABLE RESULT_VARIABLE\n"
" REQUIRED_VARIABLE1\n"
" REQUIRED_VARIABLE2 ...)\n"
"The first argument (TEST_VARIABLE) is the name of the variable to be "

4
Source/cmVariableWatchCommand.h
View File

@ -58,7 +58,7 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "VARIABLE_WATCH";}
virtual const char* GetName() { return "variable_watch";}
/**
* Succinct documentation.
@ -74,7 +74,7 @@ public:
virtual const char* GetFullDocumentation()
{
return
" VARIABLE_WATCH(<variable name> [<command to execute>])\n"
" variable_watch(<variable name> [<command to execute>])\n"
"If the specified variable changes, the message will be printed about "
"the variable being changed. If the command is spceified, the command "
"will be executed. The command will receive the following arguments:"

10
Source/cmWhileCommand.h
View File

@ -79,7 +79,7 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "WHILE";}
virtual const char* GetName() { return "while";}
/**
* Succinct documentation.
@ -95,13 +95,13 @@ public:
virtual const char* GetFullDocumentation()
{
return
" WHILE(condition)\n"
" while(condition)\n"
" COMMAND1(ARGS ...)\n"
" COMMAND2(ARGS ...)\n"
" ...\n"
" ENDWHILE(condition)\n"
"All commands between WHILE and the matching ENDWHILE are recorded "
"without being invoked. Once the ENDWHILE is evaluated, the "
" endwhile(condition)\n"
"All commands between while and the matching endwhile are recorded "
"without being invoked. Once the endwhile is evaluated, the "
"recorded list of commands is invoked as long as the condition "
"is true. The condition is evaulated using the same logic as the "
"IF command.";

14
Source/cmWriteFileCommand.h
View File

@ -48,14 +48,14 @@ public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "WRITE_FILE";}
virtual const char* GetName() { return "write_file";}
/**
* Succinct documentation.
*/
virtual const char* GetTerseDocumentation()
{
return "Deprecated. Use the FILE(WRITE ) command instead.";
return "Deprecated. Use the file(WRITE ) command instead.";
}
/**
@ -64,15 +64,15 @@ public:
virtual const char* GetFullDocumentation()
{
return
" WRITE_FILE(filename \"message to write\"... [APPEND])\n"
" write_file(filename \"message to write\"... [APPEND])\n"
"The first argument is the file name, the rest of the arguments are "
"messages to write. If the argument APPEND is specified, then "
"the message will be appended.\n"
"NOTE 1: FILE WRITE and FILE APPEND do exactly the same as this one "
"but add some more functionality.\n"
"NOTE 2: When using WRITE_FILE the produced file cannot be used as an "
"NOTE 1: file(WRITE ... and file(APPEND ... do exactly the same as "
"this one but add some more functionality.\n"
"NOTE 2: When using write_file the produced file cannot be used as an "
"input to CMake (CONFIGURE_FILE, source file ...) because it will "
"lead to an infinite loop. Use CONFIGURE_FILE if you want to generate "
"lead to an infinite loop. Use configure_file if you want to generate "
"input files to CMake.";
}

4
Tests/CommandLineTest/CMakeLists.txt
View File

@ -16,8 +16,8 @@ EXEC_CMAKE_COMMAND("-E time \"${CMAKE_COMMAND} -N -LH ${CommandLineTest_SOURCE_D
EXEC_CMAKE_COMMAND("-E time \"${CMAKE_COMMAND} -N -LAH ${CommandLineTest_SOURCE_DIR}\"")
EXEC_CMAKE_COMMAND("--help")
EXEC_CMAKE_COMMAND("--help-command-list")
EXEC_CMAKE_COMMAND("--help ADD_EXECUTABLE")
EXEC_CMAKE_COMMAND("--help-command ADD_EXECUTABLE")
EXEC_CMAKE_COMMAND("--help add_executable")
EXEC_CMAKE_COMMAND("--help-command add_executable")
EXEC_CMAKE_COMMAND("--help-full \"${CMAKE_CURRENT_BINARY_DIR}/cmake.txt\"")
EXEC_CMAKE_COMMAND("--help-man \"${CMAKE_CURRENT_BINARY_DIR}/cmake.man\"")
EXEC_CMAKE_COMMAND("--help-html \"${CMAKE_CURRENT_BINARY_DIR}/cmake.html\"")