diff options
author | Brad King <brad.king@kitware.com> | 2022-02-03 11:10:08 (GMT) |
---|---|---|
committer | Brad King <brad.king@kitware.com> | 2022-02-03 11:21:37 (GMT) |
commit | ec29a6a1a96c7f2a24de9682a656c40ef4061da4 (patch) | |
tree | fb18395c9b98d6c8104a142cd8302707acebe2c7 /Help/command | |
parent | 92459258108c0036808f29f83a8503fea18ccee9 (diff) | |
download | CMake-ec29a6a1a96c7f2a24de9682a656c40ef4061da4.zip CMake-ec29a6a1a96c7f2a24de9682a656c40ef4061da4.tar.gz CMake-ec29a6a1a96c7f2a24de9682a656c40ef4061da4.tar.bz2 |
Help: Clarify documentation on SYSTEM include directories
Mention that system include directories are searched after normal
include directories.
Document that `IMPORTED_NO_SYSTEM` and `NO_SYSTEM_FROM_IMPORTED`
do not affect `INTERFACE_SYSTEM_INCLUDE_DIRECTORIES`.
Diffstat (limited to 'Help/command')
-rw-r--r-- | Help/command/target_include_directories.rst | 15 |
1 files changed, 9 insertions, 6 deletions
diff --git a/Help/command/target_include_directories.rst b/Help/command/target_include_directories.rst index 3fc7926..9a99a7d 100644 --- a/Help/command/target_include_directories.rst +++ b/Help/command/target_include_directories.rst @@ -28,12 +28,15 @@ The following arguments specify include directories. Allow setting ``INTERFACE`` items on :ref:`IMPORTED targets <Imported Targets>`. 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 + +If ``SYSTEM`` is specified, the compiler will be told the directories +are meant as system include directories on some platforms. This may +have effects such as suppressing warnings or skipping the contained +headers in dependency calculations (see compiler documentation). +Additionally, system include directories are searched after normal +include directories regardless of the order specified. + +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. |