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

BUG: Corrected and updated documentation of the -P option, -C option, GET_TARGET_PROPERTY command, and GET_SOURCE_FILE_PROPERTY command.

Browse Source
This commit is contained in:
Brad King 2005-09-21 13:31:43 -04:00
parent 059f62c5ea
commit c59d56f653
4 changed files with 15 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Source/cmGetSourceFilePropertyCommand.h
View File

@ -53,9 +53,9 @@ public:
{ {
return 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 " "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 " "stored in the variable VAR. If the property is not found, var "
"will be set to NOT_FOUND. 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 " "property values. Source file properties usually control how the "
"file is built."; "file is built.";
} }

12
Source/cmGetTargetPropertyCommand.h
View File

@ -53,19 +53,19 @@ public:
{ {
return 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 " "Get a property from a target. The value of the property is "
"stored in the variable VAR. If the property is not found, var " "stored in the variable VAR. If the property is not found, var "
"will be set to NOT_FOUND. 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 " "property values. Properties are usually used to control how "
"a target is built. The read-only property \"LOCATION\" specifies " "a target is built.\n"
"The read-only property \"LOCATION\" specifies "
"the full path to the file on disk that will be created for the " "the full path to the file on disk that will be created for the "
"target. This is very useful for executable targets to get " "target. This is very useful for executable targets to get "
"the path to the executable file for use in a custom command. " "the path to the executable file for use in a custom command. "
"the path to the executable file for use in a custom command.\n"
"The read-only property \"TYPE\" returns which type the specified " "The read-only property \"TYPE\" returns which type the specified "
"target has (EXECUTABLE, STATIC_LIBRARY, SHARED_LIBRARY, " "target has (EXECUTABLE, STATIC_LIBRARY, SHARED_LIBRARY, "
"MODULE_LIBRARY, UTILITY, INSTALL_FILES or INSTALL_PROGRAMS)." "MODULE_LIBRARY, UTILITY, INSTALL_FILES or INSTALL_PROGRAMS). "
"This command can get properties for any target so far created. " "This command can get properties for any target so far created.\n"
"The targets do not need to be in the current CMakeLists.txt file."; "The targets do not need to be in the current CMakeLists.txt file.";
} }

6
Source/cmake.h
View File

@ -318,13 +318,15 @@ private:
}; };
#define CMAKE_STANDARD_OPTIONS_TABLE \ #define CMAKE_STANDARD_OPTIONS_TABLE \
{"-C <initial-cache>", "Pre-load cmake cache from given file.", \ {"-C <initial-cache>", "Pre-load a script to populate the cache.", \
"When cmake is first run in an empty build tree, it creates a " \ "When cmake is first run in an empty build tree, it creates a " \
"CMakeCache.txt file and populates it with customizable settings " \ "CMakeCache.txt file and populates it with customizable settings " \
"for the project. This option may be used to specify a file from " \ "for the project. This option may be used to specify a file from " \
"which to load cache entries before the first pass through " \ "which to load cache entries before the first pass through " \
"the project's cmake listfiles. The loaded entries take priority " \ "the project's cmake listfiles. The loaded entries take priority " \
"over the project's default values."}, \ "over the project's default values. The given file should be a CMake " \
"script containing SET commands that use the CACHE option, " \
"not a cache-format file."}, \
{"-D <var>:<type>=<value>", "Create a cmake cache entry.", \ {"-D <var>:<type>=<value>", "Create a cmake cache entry.", \
"When cmake is first run in an empty build tree, it creates a " \ "When cmake is first run in an empty build tree, it creates a " \
"CMakeCache.txt file and populates it with customizable settings " \ "CMakeCache.txt file and populates it with customizable settings " \

3
Source/cmakemain.cxx
View File

@ -74,6 +74,9 @@ static const cmDocumentationEntry cmDocumentationOptions[] =
"each variable."}, "each variable."},
{"-N", "View mode only.", {"-N", "View mode only.",
"Only load the cache. Do not actually run configure and generate steps."}, "Only load the cache. Do not actually run configure and generate steps."},
{"-P <file>", "Process script mode.",
"Process the given cmake file as a script written in the CMake language. "
"No configure or generate step is performed and the cache is not modified."},
{"--help-command cmd [file]", "Print help for a single command and exit.", {"--help-command cmd [file]", "Print help for a single command and exit.",
"Full documentation specific to the given command is displayed."}, "Full documentation specific to the given command is displayed."},
{"--help-command-list [file]", "List available listfile commands and exit.", {"--help-command-list [file]", "List available listfile commands and exit.",