ENH: Mention CMAKE_* variables in RPATH properties

The RPATH target properties are initialized by CMAKE_<prop> variables at
target creation time.  This notes the feature in the property
documentation.  It is already noted in the variable documentation.
This commit is contained in:
Brad King 2009-03-19 10:53:51 -04:00
parent c8f9ee6b74
commit 6d02ee34c9
1 changed files with 13 additions and 4 deletions

View File

@ -73,7 +73,9 @@ void cmTarget::DefineProperties(cmake *cm)
"BUILD_WITH_INSTALL_RPATH is a boolean specifying whether to link "
"the target in the build tree with the INSTALL_RPATH. This takes "
"precedence over SKIP_BUILD_RPATH and avoids the need for relinking "
"before installation.");
"before installation. "
"This property is initialized by the value of the variable "
"CMAKE_BUILD_WITH_INSTALL_RPATH if it is set when a target is created.");
cm->DefineProperty
("CLEAN_DIRECT_OUTPUT", cmProperty::TARGET,
@ -341,14 +343,19 @@ void cmTarget::DefineProperties(cmake *cm)
("INSTALL_RPATH", cmProperty::TARGET,
"The rpath to use for installed targets.",
"A semicolon-separated list specifying the rpath "
"to use in installed targets (for platforms that support it).");
"to use in installed targets (for platforms that support it). "
"This property is initialized by the value of the variable "
"CMAKE_INSTALL_RPATH if it is set when a target is created.");
cm->DefineProperty
("INSTALL_RPATH_USE_LINK_PATH", cmProperty::TARGET,
"Add paths to linker search and installed rpath.",
"INSTALL_RPATH_USE_LINK_PATH is a boolean that if set to true will "
"append directories in the linker search path and outside the "
"project to the INSTALL_RPATH. ");
"project to the INSTALL_RPATH. "
"This property is initialized by the value of the variable "
"CMAKE_INSTALL_RPATH_USE_LINK_PATH if it is set when a target is "
"created.");
cm->DefineProperty
("LABELS", cmProperty::TARGET,
@ -546,7 +553,9 @@ void cmTarget::DefineProperties(cmake *cm)
"Should rpaths be used for the build tree.",
"SKIP_BUILD_RPATH is a boolean specifying whether to skip automatic "
"generation of an rpath allowing the target to run from the "
"build tree. ");
"build tree. "
"This property is initialized by the value of the variable "
"CMAKE_SKIP_BUILD_RPATH if it is set when a target is created.");
cm->DefineProperty
("SOVERSION", cmProperty::TARGET,