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

Help: Link to cmake-properties.7 manual from set_target_properties docs 

Drop the partial documentation of properties from the command
documentation and reference the main properties manual instead.
Otherwise readers may not realize there are many more properties.
This commit is contained in:
Brad King 2015-07-14 14:42:37 -04:00
parent fe3c678778
commit 6b9a7938be
1 changed files with 3 additions and 94 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

97
Help/command/set_target_properties.rst
View File

@ -12,98 +12,7 @@ Targets can have properties that affect how they are built.
Set properties on a target. The syntax for the command is to list all
the files you want to change, and then provide the values you want to
set next. You can use any prop value pair you want and extract it
later with the :command:`get_target_property` command.
later with the :command:`get_property` or :command:`get_target_property`
command.
Properties that affect the name of a target's output file are as
follows. The :prop_tgt:`PREFIX` and :prop_tgt:`SUFFIX` properties
override the default target name prefix (such as "lib") and suffix
(such as ".so"). :prop_tgt:`IMPORT_PREFIX` and
:prop_tgt:`IMPORT_SUFFIX` are the equivalent properties for the import
library corresponding to a DLL (for SHARED library targets).
:prop_tgt:`OUTPUT_NAME` sets the real name of a target when it is built
and can be used to help create two targets of the same name even though
CMake requires unique logical target names. There is also a
:prop_tgt:`<CONFIG>_OUTPUT_NAME` that can set the output name on a
per-configuration basis. :prop_tgt:`<CONFIG>_POSTFIX` sets a postfix for
the real name of the target when it is built under the configuration named
by ``<CONFIG>`` (in upper-case, such as "DEBUG_POSTFIX"). The value of this
property is initialized when the target is created to the value of the
variable :variable:`CMAKE_<CONFIG>_POSTFIX`
(except for executable targets because earlier CMake versions which
did not use this variable for executables).
The :prop_tgt:`LINK_FLAGS` property can be used to add extra flags to the
link step of a target. :prop_tgt:`LINK_FLAGS_<CONFIG>` will add to the
configuration ``<CONFIG>``, for example, ``DEBUG``, ``RELEASE``,
``MINSIZEREL``,``RELWITHDEBINFO``. :prop_tgt:`DEFINE_SYMBOL` sets the name
of the preprocessor symbol defined when compiling sources in a shared
library. If not set here then it is set to target_EXPORTS by default
(with some substitutions if the target is not a valid C identifier). This
is useful for headers to know whether they are being included from inside
their library or outside to properly setup dllexport/dllimport
decorations. The :prop_tgt:`COMPILE_FLAGS` property sets additional
compiler flags used to build sources within the target. It may also be
used to pass additional preprocessor definitions.
The :prop_tgt:`LINKER_LANGUAGE` property is used to change the tool used
to link an executable or shared library. The default is set the language to
match the files in the library. ``CXX`` and ``C`` are common values for this
property.
For shared libraries :prop_tgt:`VERSION` and :prop_tgt:`SOVERSION` can be
used to specify the build version and API version respectively. When
building or installing appropriate symlinks are created if the platform
supports symlinks and the linker supports so-names. If only one of both is
specified the missing is assumed to have the same version number. For
executables :prop_tgt:`VERSION` can be used to specify the build
version. When building or installing appropriate symlinks are created if
the platform supports symlinks. For shared libraries and executables on
Windows the :prop_tgt:`VERSION` attribute is parsed to extract a
"major.minor" version number. These numbers are used as the image
version of the binary.
There are a few properties used to specify RPATH rules.
:prop_tgt:`INSTALL_RPATH` is a semicolon-separated list specifying the
rpath to use in installed targets (for platforms that support it).
:prop_tgt:`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 :prop_tgt:`INSTALL_RPATH`. :prop_tgt:`SKIP_BUILD_RPATH` is a boolean
specifying whether to skip automatic generation of an rpath allowing the
target to run from the build tree. :prop_tgt:`BUILD_WITH_INSTALL_RPATH` is
a boolean specifying whether to link the target in the build tree with the
:prop_tgt:`INSTALL_RPATH`. This takes precedence over
:prop_tgt:`SKIP_BUILD_RPATH` and avoids the need for relinking before
installation. :prop_tgt:`INSTALL_NAME_DIR` is a string specifying the
directory portion of the "install_name" field of shared libraries on
Mac OSX to use in the installed targets. When the target is created
the values of the variables :variable:`CMAKE_INSTALL_RPATH`,
:variable:`CMAKE_INSTALL_RPATH_USE_LINK_PATH`,
:variable:`CMAKE_SKIP_BUILD_RPATH`,
:variable:`CMAKE_BUILD_WITH_INSTALL_RPATH`, and
:variable:`CMAKE_INSTALL_NAME_DIR` are used to initialize these properties.
:prop_tgt:`PROJECT_LABEL` can be used to change the name of the target in
an IDE like visual studio. :prop_tgt:`VS_KEYWORD` can be set to change
the visual studio keyword, for example Qt integration works better if this
is set to ``Qt4VSv1.0``.
:prop_tgt:`VS_SCC_PROJECTNAME`, :prop_tgt:`VS_SCC_LOCALPATH`,
:prop_tgt:`VS_SCC_PROVIDER` and :prop_tgt:`VS_SCC_AUXPATH` can be set to
add support for source control bindings in a Visual Studio project file.
:prop_tgt:`VS_GLOBAL_<variable>` can be set to add a Visual Studio
project-specific global variable. Qt integration works better if
``VS_GLOBAL_QtVersion`` is set to the Qt version :module:`FindQt4`
found. For example, "4.7.3"
The :prop_tgt:`PRE_INSTALL_SCRIPT` and :prop_tgt:`POST_INSTALL_SCRIPT`
properties are the old way to specify CMake scripts to run before and
after installing a target. They are used only when the old
:command:`install_targets` command is used to install the target. Use the
:command:`install` command instead.
The :prop_tgt:`EXCLUDE_FROM_DEFAULT_BUILD` property is used by the visual
studio generators. If it is set to 1 the target will not be part of the
default build when you select "Build Solution". This can also be set
on a per-configuration basis using
:prop_tgt:`EXCLUDE_FROM_DEFAULT_BUILD_<CONFIG>`.
See :ref:`Target Properties` for the list of properties known to CMake.