summaryrefslogtreecommitdiffstats
path: root/Help/command/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/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/include_directories.rst')
-rw-r--r--Help/command/include_directories.rst33
1 files changed, 19 insertions, 14 deletions
diff --git a/Help/command/include_directories.rst b/Help/command/include_directories.rst
index 3e0c7a0..f694934 100644
--- a/Help/command/include_directories.rst
+++ b/Help/command/include_directories.rst
@@ -5,26 +5,31 @@ Add include directories to the build.
::
- include_directories([AFTER|BEFORE] [SYSTEM] dir1 dir2 ...)
+ include_directories([AFTER|BEFORE] [SYSTEM] dir1 [dir2 ...])
Add the given directories to those the compiler uses to search for
include files. Relative paths are interpreted as relative to the
current source directory.
-The include directories are added to the directory property
-INCLUDE_DIRECTORIES for the current CMakeLists file. They are also
-added to the target property INCLUDE_DIRECTORIES for each target in
-the current CMakeLists file. The target property values are the ones
-used by the generators.
+The include directories are added to the :prop_dir:`INCLUDE_DIRECTORIES`
+directory property for the current ``CMakeLists`` file. They are also
+added to the :prop_tgt:`INCLUDE_DIRECTORIES` target property for each
+target in the current ``CMakeLists`` file. The target property values
+are the ones used by the generators.
-By default the directories are appended onto the current list of
+By default the directories specified are appended onto the current list of
directories. This default behavior can be changed by setting
-:variable:`CMAKE_INCLUDE_DIRECTORIES_BEFORE` to ON. By using AFTER or BEFORE
-explicitly, you can select between appending and prepending,
-independent of the default.
+:variable:`CMAKE_INCLUDE_DIRECTORIES_BEFORE` to ``ON``. By using
+``AFTER`` or ``BEFORE`` explicitly, you can select between appending and
+prepending, independent of the default.
-If the SYSTEM option is given, 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
+If the ``SYSTEM`` option is given, 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).
+considered in dependency calculations - see compiler docs.
+
+Arguments to ``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.