summaryrefslogtreecommitdiff
path: root/Help
diff options
context:
space:
mode:
authorStephen Kelly <steveire@gmail.com>2015-01-23 00:14:32 +0100
committerStephen Kelly <steveire@gmail.com>2015-01-23 00:15:02 +0100
commit85857e6d1c1859bdc8ab4206e0329e846b6ef020 (patch)
treec9eb3ed0d193b9b30f6e8fb5cce32c681442b78b /Help
parentee38062be8ccdb7f4c53156ef00db0d42a41a6a7 (diff)
downloadcmake-85857e6d1c1859bdc8ab4206e0329e846b6ef020.tar.gz
Help: Clarify INTERFACE_SYSTEM_INCLUDE_DIRECTORIES documentation.
Diffstat (limited to 'Help')
-rw-r--r--Help/prop_tgt/INTERFACE_SYSTEM_INCLUDE_DIRECTORIES.rst11
1 files changed, 9 insertions, 2 deletions
diff --git a/Help/prop_tgt/INTERFACE_SYSTEM_INCLUDE_DIRECTORIES.rst b/Help/prop_tgt/INTERFACE_SYSTEM_INCLUDE_DIRECTORIES.rst
index b54b6c1d89..a0a97ada75 100644
--- a/Help/prop_tgt/INTERFACE_SYSTEM_INCLUDE_DIRECTORIES.rst
+++ b/Help/prop_tgt/INTERFACE_SYSTEM_INCLUDE_DIRECTORIES.rst
@@ -7,8 +7,15 @@ Targets may populate this property to publish the include directories
which contain system headers, and therefore should not result in
compiler warnings. The :command:`target_include_directories(SYSTEM)`
command signature populates this property with values given to the
-``PUBLIC`` and ``INTERFACE`` keywords. Projects may also get and set the
-property directly.
+``PUBLIC`` and ``INTERFACE`` keywords.
+
+Projects may also get and set the property directly, but must be aware that
+adding directories to this property does not make those directories used
+during compilation. Adding directories to this property marks directories
+as ``SYSTEM`` which otherwise would be used in a non-``SYSTEM`` manner. This
+can appear similar to 'duplication', so prefer the
+high-level :command:`target_include_directories(SYSTEM)` command and avoid
+setting the property by low-level means.
When target dependencies are specified using :command:`target_link_libraries`,
CMake will read this property from all target dependencies to mark the