"Fossies" - the Fresh Open Source Software Archive

Member "cmake-3.6.2-win32-x86/share/cmake-3.6/Help/command/target_include_directories.rst" (7 Sep 2016, 2783 Bytes) of archive /windows/misc/cmake-3.6.2-win32-x86.zip:

As a special service "Fossies" has tried to format the requested source page into HTML format (assuming markdown format). Alternatively you can here view or download the uninterpreted source code file. A member file download can also be achieved by clicking within a package contents listing on the according byte size field.


Add include directories to a target.


target_include_directories( [SYSTEM] [BEFORE] <INTERFACE|PUBLIC|PRIVATE> [items1…] [<INTERFACE|PUBLIC|PRIVATE> [items2…] …])

Specify include directories to use when compiling a given target. The named <target> must have been created by a command such as :command:add_executable or :command:add_library and must not be an :prop_tgt:IMPORTED target.

If BEFORE is specified, the content will be prepended to the property instead of being appended.

The INTERFACE, PUBLIC and PRIVATE keywords are required to specify the scope of the following arguments. PRIVATE and PUBLIC items will populate the :prop_tgt:INCLUDE_DIRECTORIES property of <target>. PUBLIC and INTERFACE items will populate the :prop_tgt:INTERFACE_INCLUDE_DIRECTORIES property of <target>. The following arguments specify include directories.

Specified include directories may be absolute paths or relative paths. Repeated calls for the same append items in the order called. If SYSTEM is specified, the compiler will be told the directories are meant as system include directories on some platforms (signalling this setting might achieve effects such as the compiler skipping warnings, or these fixed-install system files not being considered in dependency calculations - see compiler docs). If SYSTEM is used together with PUBLIC or INTERFACE, the :prop_tgt:INTERFACE_SYSTEM_INCLUDE_DIRECTORIES target property will be populated with the specified directories.

Arguments to target_include_directories may use “generator expressions” with the syntax $<...>. See the :manual:cmake-generator-expressions(7) manual for available expressions. See the :manual:cmake-buildsystem(7) manual for more on defining buildsystem properties.

Include directories usage requirements commonly differ between the build-tree and the install-tree. The BUILD_INTERFACE and INSTALL_INTERFACE generator expressions can be used to describe separate usage requirements based on the usage location. Relative paths are allowed within the INSTALL_INTERFACE expression and are interpreted relative to the installation prefix. For example:

.. code-block:: cmake

target_include_directories(mylib PUBLIC $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include/mylib> $<INSTALL_INTERFACE:include/mylib> # /include/mylib )

Creating Relocatable Packages ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^