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

Docs: Clarify wording "flag used" => "flag (to|will) be used" 

The phrase "flag used" is somewhat imprecise, so extend it to stress
intentions.

Also correct:

- "Flag" => "Flags"
- "[CMAKE_BUILD_TYPE]" => "<CONFIG>"
This commit is contained in:
Andreas Mohr 2013-05-04 15:27:40 +02:00 committed by Brad King
parent 2378a698a9
commit 7cc2805cd6
1 changed files with 16 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
Source/cmDocumentVariables.cxx
View File

@ -1376,38 +1376,41 @@ void cmDocumentVariables::DefineVariables(cmake* cm)
cm->DefineProperty cm->DefineProperty
("CMAKE_EXE_LINKER_FLAGS", cmProperty::VARIABLE, ("CMAKE_EXE_LINKER_FLAGS", cmProperty::VARIABLE,
"Linker flags used to create executables.", "Linker flags to be used to create executables.",
"Flags used by the linker when creating an executable.",false, "These flags will be used by the linker when creating an executable."
,false,
"Variables that Control the Build"); "Variables that Control the Build");
cm->DefineProperty cm->DefineProperty
("CMAKE_EXE_LINKER_FLAGS_[CMAKE_BUILD_TYPE]", cmProperty::VARIABLE, ("CMAKE_EXE_LINKER_FLAGS_<CONFIG>", cmProperty::VARIABLE,
"Flag used when linking an executable.", "Flags to be used when linking an executable.",
"Same as CMAKE_C_FLAGS_* but used by the linker " "Same as CMAKE_C_FLAGS_* but used by the linker "
"when creating executables.",false, "when creating executables.",false,
"Variables that Control the Build"); "Variables that Control the Build");
cm->DefineProperty cm->DefineProperty
("CMAKE_LIBRARY_PATH_FLAG", cmProperty::VARIABLE, ("CMAKE_LIBRARY_PATH_FLAG", cmProperty::VARIABLE,
"The flag used to add a library search path to a compiler.", "The flag to be used to add a library search path to a compiler.",
"The flag used to specify a library directory to the compiler. " "The flag will be used to specify a library directory to the compiler. "
"On most compilers this is \"-L\".",false, "On most compilers this is \"-L\".",false,
"Variables that Control the Build"); "Variables that Control the Build");
cm->DefineProperty cm->DefineProperty
("CMAKE_LINK_DEF_FILE_FLAG ", cmProperty::VARIABLE, ("CMAKE_LINK_DEF_FILE_FLAG ", cmProperty::VARIABLE,
"Linker flag used to specify a .def file for dll creation.", "Linker flag to be used to specify a .def file for dll creation.",
"The flag used to add a .def file when creating " "The flag will be used to add a .def file when creating "
"a dll on Windows, this is only defined on Windows.",false, "a dll on Windows; this is only defined on Windows."
,false,
"Variables that Control the Build"); "Variables that Control the Build");
cm->DefineProperty cm->DefineProperty
("CMAKE_LINK_LIBRARY_FLAG", cmProperty::VARIABLE, ("CMAKE_LINK_LIBRARY_FLAG", cmProperty::VARIABLE,
"Flag used to link a library into an executable.", "Flag to be used to link a library into an executable.",
"The flag used to specify a library to link to an executable. " "The flag will be used to specify a library to link to an executable. "
"On most compilers this is \"-l\".",false, "On most compilers this is \"-l\".",false,
"Variables that Control the Build"); "Variables that Control the Build");
cm->DefineProperty cm->DefineProperty
("CMAKE_LINK_LIBRARY_FILE_FLAG", cmProperty::VARIABLE, ("CMAKE_LINK_LIBRARY_FILE_FLAG", cmProperty::VARIABLE,
"Flag used to link a library specified by a path to its file.", "Flag to be used to link a library specified by a path to its file.",
"The flag used before a library file path is given to the linker. " "The flag will be used before a library file path is given to the "
"linker. "
"This is needed only on very few platforms.", false, "This is needed only on very few platforms.", false,
"Variables that Control the Build"); "Variables that Control the Build");
cm->DefineProperty cm->DefineProperty