summaryrefslogtreecommitdiffstats
path: root/Help/command
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2020-07-31 14:31:25 (GMT)
committerBrad King <brad.king@kitware.com>2020-07-31 14:32:59 (GMT)
commit1b0adeea819e82d19da190c47bab06e1f355cf8f (patch)
tree318eec4d312ab3bfdb4c95497ce016a2a39ceff4 /Help/command
parent261a2585d9df7113a5ba7c9beacb641754444523 (diff)
downloadCMake-1b0adeea819e82d19da190c47bab06e1f355cf8f.zip
CMake-1b0adeea819e82d19da190c47bab06e1f355cf8f.tar.gz
CMake-1b0adeea819e82d19da190c47bab06e1f355cf8f.tar.bz2
Help: Clarify target_sources PRIVATE/PUBLIC/INTERFACE scopes
Diffstat (limited to 'Help/command')
-rw-r--r--Help/command/target_sources.rst14
1 files changed, 8 insertions, 6 deletions
diff --git a/Help/command/target_sources.rst b/Help/command/target_sources.rst
index 856d869..653b8d7 100644
--- a/Help/command/target_sources.rst
+++ b/Help/command/target_sources.rst
@@ -11,19 +11,21 @@ Add sources to a target.
<INTERFACE|PUBLIC|PRIVATE> [items1...]
[<INTERFACE|PUBLIC|PRIVATE> [items2...] ...])
-Specifies sources to use when compiling a given target. Relative
-source file paths are interpreted as being relative to the current
+Specifies sources to use when building a target and/or its dependents.
+Relative source file paths are interpreted as being relative to the current
source directory (i.e. :variable:`CMAKE_CURRENT_SOURCE_DIR`). The
named ``<target>`` must have been created by a command such as
:command:`add_executable` or :command:`add_library` and must not be an
:ref:`ALIAS target <Alias Targets>`.
The ``INTERFACE``, ``PUBLIC`` and ``PRIVATE`` keywords are required to
-specify the scope of the following arguments. ``PRIVATE`` and ``PUBLIC``
+specify the scope of the items following them. ``PRIVATE`` and ``PUBLIC``
items will populate the :prop_tgt:`SOURCES` property of
-``<target>``. ``PUBLIC`` and ``INTERFACE`` items will populate the
-:prop_tgt:`INTERFACE_SOURCES` property of ``<target>``.
-(:ref:`IMPORTED targets <Imported Targets>` only support ``INTERFACE`` items.)
+``<target>``, which are used when building the target itself.
+``PUBLIC`` and ``INTERFACE`` items will populate the
+:prop_tgt:`INTERFACE_SOURCES` property of ``<target>``, which are used
+when building dependents. (:ref:`IMPORTED targets <Imported Targets>`
+only support ``INTERFACE`` items because they are not build targets.)
The following arguments specify sources. Repeated calls for the same
``<target>`` append items in the order called.