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

Clarify IMPORTED_ target property documentation 

These properties are meant to be set to tell CMake something, not read
to get information from CMake.
This commit is contained in:
Brad King 2012-01-25 16:17:43 -05:00
parent 731f996ce0
commit 7d20619fbe
1 changed files with 29 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

66
Source/cmTarget.cxx
View File

@ -323,7 +323,8 @@ void cmTarget::DefineProperties(cmake *cm)
cm->DefineProperty cm->DefineProperty
("IMPORTED_CONFIGURATIONS", cmProperty::TARGET, ("IMPORTED_CONFIGURATIONS", cmProperty::TARGET,
"Configurations provided for an IMPORTED target.", "Configurations provided for an IMPORTED target.",
"Lists configuration names available for an IMPORTED target. " "Set this to the list of configuration names available for an "
"IMPORTED target. "
"The names correspond to configurations defined in the project from " "The names correspond to configurations defined in the project from "
"which the target is imported. " "which the target is imported. "
"If the importing project uses a different set of configurations " "If the importing project uses a different set of configurations "
@ -334,14 +335,12 @@ void cmTarget::DefineProperties(cmake *cm)
cm->DefineProperty cm->DefineProperty
("IMPORTED_IMPLIB", cmProperty::TARGET, ("IMPORTED_IMPLIB", cmProperty::TARGET,
"Full path to the import library for an IMPORTED target.", "Full path to the import library for an IMPORTED target.",
"Specifies the location of the \".lib\" part of a windows DLL. " "Set this to the location of the \".lib\" part of a windows DLL. "
"Ignored for non-imported targets."); "Ignored for non-imported targets.");
cm->DefineProperty cm->DefineProperty
("IMPORTED_IMPLIB_<CONFIG>", cmProperty::TARGET, ("IMPORTED_IMPLIB_<CONFIG>", cmProperty::TARGET,
"Per-configuration version of IMPORTED_IMPLIB property.", "<CONFIG>-specific version of IMPORTED_IMPLIB property.",
"This property is used when loading settings for the <CONFIG> "
"configuration of an imported target. "
"Configuration names correspond to those provided by the project " "Configuration names correspond to those provided by the project "
"from which the target is imported."); "from which the target is imported.");
@ -351,8 +350,10 @@ void cmTarget::DefineProperties(cmake *cm)
"Shared libraries may be linked to other shared libraries as part " "Shared libraries may be linked to other shared libraries as part "
"of their implementation. On some platforms the linker searches " "of their implementation. On some platforms the linker searches "
"for the dependent libraries of shared libraries they are including " "for the dependent libraries of shared libraries they are including "
"in the link. This property lists " "in the link. "
"the dependent shared libraries of an imported library. The list " "Set this property to the list of dependent shared libraries of an "
"imported library. "
"The list "
"should be disjoint from the list of interface libraries in the " "should be disjoint from the list of interface libraries in the "
"IMPORTED_LINK_INTERFACE_LIBRARIES property. On platforms requiring " "IMPORTED_LINK_INTERFACE_LIBRARIES property. On platforms requiring "
"dependent shared libraries to be found at link time CMake uses this " "dependent shared libraries to be found at link time CMake uses this "
@ -361,9 +362,7 @@ void cmTarget::DefineProperties(cmake *cm)
cm->DefineProperty cm->DefineProperty
("IMPORTED_LINK_DEPENDENT_LIBRARIES_<CONFIG>", cmProperty::TARGET, ("IMPORTED_LINK_DEPENDENT_LIBRARIES_<CONFIG>", cmProperty::TARGET,
"Per-configuration version of IMPORTED_LINK_DEPENDENT_LIBRARIES.", "<CONFIG>-specific version of IMPORTED_LINK_DEPENDENT_LIBRARIES.",
"This property is used when loading settings for the <CONFIG> "
"configuration of an imported target. "
"Configuration names correspond to those provided by the project " "Configuration names correspond to those provided by the project "
"from which the target is imported. " "from which the target is imported. "
"If set, this property completely overrides the generic property " "If set, this property completely overrides the generic property "
@ -372,8 +371,8 @@ void cmTarget::DefineProperties(cmake *cm)
cm->DefineProperty cm->DefineProperty
("IMPORTED_LINK_INTERFACE_LIBRARIES", cmProperty::TARGET, ("IMPORTED_LINK_INTERFACE_LIBRARIES", cmProperty::TARGET,
"Transitive link interface of an IMPORTED target.", "Transitive link interface of an IMPORTED target.",
"Lists libraries whose interface is included when an IMPORTED library " "Set this to the list of libraries whose interface is included when "
"target is linked to another target. " "an IMPORTED library target is linked to another target. "
"The libraries will be included on the link line for the target. " "The libraries will be included on the link line for the target. "
"Unlike the LINK_INTERFACE_LIBRARIES property, this property applies " "Unlike the LINK_INTERFACE_LIBRARIES property, this property applies "
"to all imported target types, including STATIC libraries. " "to all imported target types, including STATIC libraries. "
@ -381,9 +380,7 @@ void cmTarget::DefineProperties(cmake *cm)
cm->DefineProperty cm->DefineProperty
("IMPORTED_LINK_INTERFACE_LIBRARIES_<CONFIG>", cmProperty::TARGET, ("IMPORTED_LINK_INTERFACE_LIBRARIES_<CONFIG>", cmProperty::TARGET,
"Per-configuration version of IMPORTED_LINK_INTERFACE_LIBRARIES.", "<CONFIG>-specific version of IMPORTED_LINK_INTERFACE_LIBRARIES.",
"This property is used when loading settings for the <CONFIG> "
"configuration of an imported target. "
"Configuration names correspond to those provided by the project " "Configuration names correspond to those provided by the project "
"from which the target is imported. " "from which the target is imported. "
"If set, this property completely overrides the generic property " "If set, this property completely overrides the generic property "
@ -392,8 +389,8 @@ void cmTarget::DefineProperties(cmake *cm)
cm->DefineProperty cm->DefineProperty
("IMPORTED_LINK_INTERFACE_LANGUAGES", cmProperty::TARGET, ("IMPORTED_LINK_INTERFACE_LANGUAGES", cmProperty::TARGET,
"Languages compiled into an IMPORTED static library.", "Languages compiled into an IMPORTED static library.",
"Lists languages of soure files compiled to produce a STATIC IMPORTED " "Set this to the list of languages of source files compiled to "
"library (such as \"C\" or \"CXX\"). " "produce a STATIC IMPORTED library (such as \"C\" or \"CXX\"). "
"CMake accounts for these languages when computing how to link a " "CMake accounts for these languages when computing how to link a "
"target to the imported library. " "target to the imported library. "
"For example, when a C executable links to an imported C++ static " "For example, when a C executable links to an imported C++ static "
@ -405,9 +402,7 @@ void cmTarget::DefineProperties(cmake *cm)
cm->DefineProperty cm->DefineProperty
("IMPORTED_LINK_INTERFACE_LANGUAGES_<CONFIG>", cmProperty::TARGET, ("IMPORTED_LINK_INTERFACE_LANGUAGES_<CONFIG>", cmProperty::TARGET,
"Per-configuration version of IMPORTED_LINK_INTERFACE_LANGUAGES.", "<CONFIG>-specific version of IMPORTED_LINK_INTERFACE_LANGUAGES.",
"This property is used when loading settings for the <CONFIG> "
"configuration of an imported target. "
"Configuration names correspond to those provided by the project " "Configuration names correspond to those provided by the project "
"from which the target is imported. " "from which the target is imported. "
"If set, this property completely overrides the generic property " "If set, this property completely overrides the generic property "
@ -419,16 +414,14 @@ void cmTarget::DefineProperties(cmake *cm)
"This is LINK_INTERFACE_MULTIPLICITY for IMPORTED targets."); "This is LINK_INTERFACE_MULTIPLICITY for IMPORTED targets.");
cm->DefineProperty cm->DefineProperty
("IMPORTED_LINK_INTERFACE_MULTIPLICITY_<CONFIG>", cmProperty::TARGET, ("IMPORTED_LINK_INTERFACE_MULTIPLICITY_<CONFIG>", cmProperty::TARGET,
"Per-configuration repetition count for cycles of IMPORTED archives.", "<CONFIG>-specific version of IMPORTED_LINK_INTERFACE_MULTIPLICITY.",
"This is the configuration-specific version of "
"IMPORTED_LINK_INTERFACE_MULTIPLICITY. "
"If set, this property completely overrides the generic property " "If set, this property completely overrides the generic property "
"for the named configuration."); "for the named configuration.");
cm->DefineProperty cm->DefineProperty
("IMPORTED_LOCATION", cmProperty::TARGET, ("IMPORTED_LOCATION", cmProperty::TARGET,
"Full path to the main file on disk for an IMPORTED target.", "Full path to the main file on disk for an IMPORTED target.",
"Specifies the location of an IMPORTED target file on disk. " "Set this to the location of an IMPORTED target file on disk. "
"For executables this is the location of the executable file. " "For executables this is the location of the executable file. "
"For bundles on OS X this is the location of the executable file " "For bundles on OS X this is the location of the executable file "
"inside Contents/MacOS under the application bundle folder. " "inside Contents/MacOS under the application bundle folder. "
@ -440,28 +433,29 @@ void cmTarget::DefineProperties(cmake *cm)
"symlink just inside the framework folder. " "symlink just inside the framework folder. "
"For DLLs this is the location of the \".dll\" part of the library. " "For DLLs this is the location of the \".dll\" part of the library. "
"For UNKNOWN libraries this is the location of the file to be linked. " "For UNKNOWN libraries this is the location of the file to be linked. "
"Ignored for non-imported targets."); "Ignored for non-imported targets."
"\n"
"Projects may skip IMPORTED_LOCATION if the configuration-specific "
"property IMPORTED_LOCATION_<CONFIG> is set. "
"To get the location of an imported target read one of the "
"LOCATION or LOCATION_<CONFIG> properties.");
cm->DefineProperty cm->DefineProperty
("IMPORTED_LOCATION_<CONFIG>", cmProperty::TARGET, ("IMPORTED_LOCATION_<CONFIG>", cmProperty::TARGET,
"Per-configuration version of IMPORTED_LOCATION property.", "<CONFIG>-specific version of IMPORTED_LOCATION property.",
"This property is used when loading settings for the <CONFIG> "
"configuration of an imported target. "
"Configuration names correspond to those provided by the project " "Configuration names correspond to those provided by the project "
"from which the target is imported."); "from which the target is imported.");
cm->DefineProperty cm->DefineProperty
("IMPORTED_SONAME", cmProperty::TARGET, ("IMPORTED_SONAME", cmProperty::TARGET,
"The \"soname\" of an IMPORTED target of shared library type.", "The \"soname\" of an IMPORTED target of shared library type.",
"Specifies the \"soname\" embedded in an imported shared library. " "Set this to the \"soname\" embedded in an imported shared library. "
"This is meaningful only on platforms supporting the feature. " "This is meaningful only on platforms supporting the feature. "
"Ignored for non-imported targets."); "Ignored for non-imported targets.");
cm->DefineProperty cm->DefineProperty
("IMPORTED_SONAME_<CONFIG>", cmProperty::TARGET, ("IMPORTED_SONAME_<CONFIG>", cmProperty::TARGET,
"Per-configuration version of IMPORTED_SONAME property.", "<CONFIG>-specific version of IMPORTED_SONAME property.",
"This property is used when loading settings for the <CONFIG> "
"configuration of an imported target. "
"Configuration names correspond to those provided by the project " "Configuration names correspond to those provided by the project "
"from which the target is imported."); "from which the target is imported.");
@ -477,9 +471,7 @@ void cmTarget::DefineProperties(cmake *cm)
cm->DefineProperty cm->DefineProperty
("IMPORTED_NO_SONAME_<CONFIG>", cmProperty::TARGET, ("IMPORTED_NO_SONAME_<CONFIG>", cmProperty::TARGET,
"Per-configuration version of IMPORTED_NO_SONAME property.", "<CONFIG>-specific version of IMPORTED_NO_SONAME property.",
"This property is used when loading settings for the <CONFIG> "
"configuration of an imported target. "
"Configuration names correspond to those provided by the project " "Configuration names correspond to those provided by the project "
"from which the target is imported."); "from which the target is imported.");
@ -685,8 +677,8 @@ void cmTarget::DefineProperties(cmake *cm)
cm->DefineProperty cm->DefineProperty
("MAP_IMPORTED_CONFIG_<CONFIG>", cmProperty::TARGET, ("MAP_IMPORTED_CONFIG_<CONFIG>", cmProperty::TARGET,
"Map from project configuration to IMPORTED target's configuration.", "Map from project configuration to IMPORTED target's configuration.",
"List configurations of an imported target that may be used for " "Set this to the list of configurations of an imported target that "
"the current project's <CONFIG> configuration. " "may be used for the current project's <CONFIG> configuration. "
"Targets imported from another project may not provide the same set " "Targets imported from another project may not provide the same set "
"of configuration names available in the current project. " "of configuration names available in the current project. "
"Setting this property tells CMake what imported configurations are " "Setting this property tells CMake what imported configurations are "