summaryrefslogtreecommitdiffstats
path: root/Help/prop_dir/INCLUDE_DIRECTORIES.rst
diff options
context:
space:
mode:
authorStephen Kelly <steveire@gmail.com>2014-02-05 13:51:08 (GMT)
committerBrad King <brad.king@kitware.com>2014-02-06 21:15:53 (GMT)
commit3879c847825d40a439b0ec55421309ab9b33c1ee (patch)
tree42f3d3b7a615b5aed7e253c7468bfd8c8369fabf /Help/prop_dir/INCLUDE_DIRECTORIES.rst
parentba4c2fa8fd2a03f7d69e60d581d44a3cc79a3c9a (diff)
downloadCMake-3879c847825d40a439b0ec55421309ab9b33c1ee.zip
CMake-3879c847825d40a439b0ec55421309ab9b33c1ee.tar.gz
CMake-3879c847825d40a439b0ec55421309ab9b33c1ee.tar.bz2
Help: Document relation of properties to the rest of the buildsystem.
Diffstat (limited to 'Help/prop_dir/INCLUDE_DIRECTORIES.rst')
-rw-r--r--Help/prop_dir/INCLUDE_DIRECTORIES.rst28
1 files changed, 18 insertions, 10 deletions
diff --git a/Help/prop_dir/INCLUDE_DIRECTORIES.rst b/Help/prop_dir/INCLUDE_DIRECTORIES.rst
index 6c5782f..baba49b 100644
--- a/Help/prop_dir/INCLUDE_DIRECTORIES.rst
+++ b/Help/prop_dir/INCLUDE_DIRECTORIES.rst
@@ -4,15 +4,23 @@ INCLUDE_DIRECTORIES
List of preprocessor include file search directories.
This property specifies the list of directories given so far to the
-include_directories command. This property exists on directories and
-targets. In addition to accepting values from the include_directories
-command, values may be set directly on any directory or any target
-using the set_property command. A target gets its initial value for
-this property from the value of the directory property. A directory
-gets its initial value from its parent directory if it has one. Both
-directory and target property values are adjusted by calls to the
-include_directories command.
+:command:`include_directories` command.
+
+This property is used to populate the :prop_tgt:`INCLUDE_DIRECTORIES`
+target property, which is used by the generators to set the include
+directories for the compiler.
+
+In addition to accepting values from that command, values may be set
+directly on any directory using the :command:`set_property` command. A
+directory gets its initial value from its parent directory if it has one.
+The intial value of the :prop_tgt:`INCLUDE_DIRECTORIES` target property
+comes from the value of this property. Both directory and target property
+values are adjusted by calls to the :command:`include_directories` command.
The target property values are used by the generators to set the
-include paths for the compiler. See also the include_directories
-command.
+include paths for the compiler.
+
+Contents of ``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.