summaryrefslogtreecommitdiffstats
path: root/Help/command/target_include_directories.rst
diff options
context:
space:
mode:
authorStephen Kelly <steveire@gmail.com>2014-02-03 13:20:42 (GMT)
committerBrad King <brad.king@kitware.com>2014-02-06 21:15:53 (GMT)
commitba4c2fa8fd2a03f7d69e60d581d44a3cc79a3c9a (patch)
treef44187babf7f2eb84c5532789783a6d5a6bbdeee /Help/command/target_include_directories.rst
parenta683262a727c4fd2c9e3271e6bc36679d0963342 (diff)
downloadCMake-ba4c2fa8fd2a03f7d69e60d581d44a3cc79a3c9a.zip
CMake-ba4c2fa8fd2a03f7d69e60d581d44a3cc79a3c9a.tar.gz
CMake-ba4c2fa8fd2a03f7d69e60d581d44a3cc79a3c9a.tar.bz2
Help: Mark up the buildsystem commands documentation
Cross-link to the cmake-buildsystem manual.
Diffstat (limited to 'Help/command/target_include_directories.rst')
-rw-r--r--Help/command/target_include_directories.rst47
1 files changed, 26 insertions, 21 deletions
diff --git a/Help/command/target_include_directories.rst b/Help/command/target_include_directories.rst
index 2fd7d7f..75f917d 100644
--- a/Help/command/target_include_directories.rst
+++ b/Help/command/target_include_directories.rst
@@ -5,33 +5,38 @@ Add include directories to a target.
::
- target_include_directories(<target> [SYSTEM] [BEFORE] <INTERFACE|PUBLIC|PRIVATE> [items1...]
+ target_include_directories(<target> [SYSTEM] [BEFORE]
+ <INTERFACE|PUBLIC|PRIVATE> [items1...]
[<INTERFACE|PUBLIC|PRIVATE> [items2...] ...])
Specify include directories or targets to use when compiling a given
-target. The named <target> must have been created by a command such
-as add_executable or add_library and must not be an IMPORTED target.
+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
+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 INCLUDE_DIRECTORIES property of <target>. PUBLIC and
-INTERFACE items will populate the 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 <target> append items in
-the order called.If SYSTEM is specified, the compiler will be told the
+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 <target> 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
-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.
+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.