Updates will be applied on October 27th between 12pm - 12:45pm EDT (UTC-0400). Gitlab may be slow during the maintenance window.

Commit 4d9259c1 authored by Amitha Perera's avatar Amitha Perera
Browse files

STYLE: Spelling fixes on documentation

parent acb27977
......@@ -73,8 +73,8 @@ public:
"(using main). The variable CMAKE_MFC_FLAG be used if the windows app "
"uses MFC. This variable can be set to the following values:\n"
" 0: Use Standard Windows Libraries\n"
" 1: Use MFC in a Static Library \n"
" 2: Use MFC in a Shared DLL \n"
" 1: Use MFC in a Static Library\n"
" 2: Use MFC in a Shared DLL\n"
"MACOSX_BUNDLE indicates that when build on Mac OSX, executable should "
"be in the bundle form. The MACOSX_BUNDLE also allows several "
"variables to be specified:\n"
......
......@@ -61,7 +61,7 @@ public:
return
" configure_file(InputFile OutputFile\n"
" [COPYONLY] [ESCAPE_QUOTES] [@ONLY])\n"
"The Input and Ouput files have to have full paths. "
"The Input and Output files have to have full paths. "
"This command replaces any variables in the input file referenced as "
"${VAR} or @VAR@ with their values as determined by CMake. If a "
"variable is not defined, it will be replaced with nothing. "
......
......@@ -84,7 +84,7 @@ static const char *cmPropertiesDocumentationDescription[][3] =
"This is the documentation for the properties supported by CMake. "
"Properties can have different scopes. They can either be assigned to a "
"source file, a directory, a target or globally to CMake. By modifying the "
"values of properties the behaviour of the buildsystem can be customized.",
"values of properties the behaviour of the build system can be customized.",
0},
{0,0,0}
};
......
......@@ -66,7 +66,7 @@ public:
" 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. "
"any of the extra variables that are created by the project command. "
"Example languages are CXX, C, Fortran.\n"
"If OPTIONAL is used, use the CMAKE_<languageName>_COMPILER_WORKS "
"variable to check whether the language has been enabled successfully.";
......
......@@ -44,7 +44,7 @@ cmFindBase::cmFindBase()
"is sufficient in many cases. It is the same "
"as FIND_XXX(<VAR> name1 PATHS path2 path2 ...)\n"
" FIND_XXX(\n"
" <VAR> \n"
" <VAR>\n"
" name | NAMES name1 [name2 ...]\n"
" PATHS path1 [path2 ... ENV var]\n"
" [PATH_SUFFIXES suffix1 [suffix2 ...]]\n"
......
......@@ -2889,7 +2889,7 @@ void cmMakefile::DefineProperties(cmake *cm)
{
cm->DefineProperty
("ADDITIONAL_MAKE_CLEAN_FILES", cmProperty::DIRECTORY,
"Addditional files to clean during the make clean stage.",
"Additional files to clean during the make clean stage.",
"A list of files that will be cleaned as a part of the "
"\"make clean\" stage. ");
......
......@@ -331,10 +331,10 @@ void cmSourceFile::DefineProperties(cmake *cm)
cm->DefineProperty
("ABSTRACT", cmProperty::SOURCE_FILE,
"Is this source file an abstract class.",
"A property ona source file that indicates if the source file "
"A property on a source file that indicates if the source file "
"represents a class that is abstract. This only makes sense for "
"languages that have a notion of an abstract class and it is "
"only used by somw tools that wrap classes into other languages.");
"only used by some tools that wrap classes into other languages.");
cm->DefineProperty
("COMPILE_FLAGS", cmProperty::SOURCE_FILE,
......@@ -366,7 +366,7 @@ void cmSourceFile::DefineProperties(cmake *cm)
cm->DefineProperty
("HEADER_FILE_ONLY", cmProperty::SOURCE_FILE,
"Is this source file only a header file.",
"A property ona source file that indicates if the source file "
"A property on a source file that indicates if the source file "
"is a header file with no associated implementation. This is "
"set automatically based on the file extension and is used by "
"CMake to determine is certain dependency information should be "
......@@ -374,7 +374,7 @@ void cmSourceFile::DefineProperties(cmake *cm)
cm->DefineProperty
("KEEP_EXTENSION", cmProperty::SOURCE_FILE,
"Make th eoutput file have the same extension as the source file.",
"Make the output file have the same extension as the source file.",
"If this property is set then the file extension of the output "
"file will be the same as that of the source file. Normally "
"the output file extension is computed based on the language "
......
......@@ -104,7 +104,7 @@ public:
"subexpressions of the match using \\1, \\2, ..., \\9. Note that "
"two backslashes (\\\\1) are required in CMake code to get a "
"backslash through argument parsing.\n"
"REPLACE will replace all occurences of match_string in the input with "
"REPLACE will replace all occurrences of match_string in the input with "
"replace_string and store the result in the output.\n"
"COMPARE EQUAL/NOTEQUAL/LESS/GREATER will compare the strings and "
"store true or false in the output variable.\n"
......
......@@ -54,7 +54,7 @@ void cmTarget::DefineProperties(cmake *cm)
cm->DefineProperty
("CLEAN_DIRECT_OUTPUT", cmProperty::TARGET,
"Do not delete other varients of this target.",
"Do not delete other variants of this target.",
"When a library is built CMake by default generates code to remove "
"any existing library using all possible names. This is needed "
"to support libraries that switch between STATIC and SHARED by "
......@@ -65,7 +65,7 @@ void cmTarget::DefineProperties(cmake *cm)
cm->DefineProperty
("COMPILE_FLAGS", cmProperty::TARGET,
"Additional flags to yse when compiling this target's sources.",
"Additional flags to use when compiling this target's sources.",
"The COMPILE_FLAGS property sets additional compiler flags used "
"to build sources within the target. It may also be used to pass "
"additional preprocessor definitions.");
......@@ -84,7 +84,7 @@ void cmTarget::DefineProperties(cmake *cm)
cm->DefineProperty
("DEBUG_POSTFIX", cmProperty::TARGET,
"A postfix that will be applied to this target when build debug.",
"A property on a target that sepcifies a postfix to add to the "
"A property on a target that specifies a postfix to add to the "
"target name when built in debug mode. For example foo.dll "
"versus fooD.dll");
......@@ -175,7 +175,7 @@ void cmTarget::DefineProperties(cmake *cm)
("LOCATION", cmProperty::TARGET,
"Where a target will be written on disk.",
"A read only property on a target that indicates where that target "
"will be written. For libraries and execuatables this will be where "
"will be written. For libraries and executables this will be where "
"the file is written on disk. This property is computed based on a "
"number of other settings.");
......
......@@ -98,14 +98,14 @@ void cmTest::DefineProperties(cmake *cm)
// define properties
cm->DefineProperty
("FAIL_REGULAR_EXPRESSION", cmProperty::TEST,
"If the output matches this regular expression tes test will fail.",
"If the output matches this regular expression the test will fail.",
"If set, if the output matches one of "
"specified regular expressions, the test will fail."
"For example: PASS_REGULAR_EXPRESSION \"[^a-z]Error;ERROR;Failed\"");
cm->DefineProperty
("MEASUREMENT", cmProperty::TEST,
"Specify a DART meansurement and value to be reported for a test.",
"Specify a DART measurement and value to be reported for a test.",
"If set to a name then that name will be reported to DART as a "
"named measurement with a value of 1. You may also specify a value "
"by setting MEASUREMENT to \"measurement=value\".");
......@@ -120,11 +120,11 @@ void cmTest::DefineProperties(cmake *cm)
cm->DefineProperty
("TIMEOUT", cmProperty::TEST,
"How many seconds to allow for this test.",
"This property if set will limit a test to nto take more than "
"This property if set will limit a test to not take more than "
"the specified number of seconds to run. If it exceeds that the "
"test process will be killed and ctest will move to the next test. "
"This setting takes precedence over DART_TESTING_TIMEOUT and "
"CTEST_TESTING_TIMOUT.");
"CTEST_TESTING_TIMEOUT.");
cm->DefineProperty
("WILL_FAIL", cmProperty::TEST,
......
......@@ -74,7 +74,7 @@ public:
" [COPY_FILE <filename> )\n"
"Try compiling a srcfile. In this case, the user need only supply a "
"source file. CMake will create the appropriate CMakeLists.txt file "
"to build the source. If COPY_FILE is used, the compiled file will be"
"to build the source. If COPY_FILE is used, the compiled file will be "
"copied to the given file.\n"
"In this version all files in bindir/CMakeFiles/CMakeTmp, "
"will be cleaned automatically, for debugging a --debug-trycompile can "
......
......@@ -76,7 +76,7 @@ public:
return
" 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 "
"the variable being changed. If the command is specified, the command "
"will be executed. The command will receive the following arguments:"
" COMMAND(<variable> <access> <value> <current list file> <stack>)";
}
......
......@@ -103,7 +103,7 @@ public:
"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 "
"is true. The condition is evaluated using the same logic as the "
"if command.";
}
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment