summaryrefslogtreecommitdiffstats
path: root/Help/prop_tgt/SOURCES.rst
diff options
context:
space:
mode:
authorArcturus Arcturus <arcturus98@outlook.com>2021-10-29 22:02:34 (GMT)
committerCraig Scott <craig.scott@crascit.com>2021-11-02 22:02:32 (GMT)
commit9abd63dd3aea53008d1d01dc361a1a486215520c (patch)
tree524c0dd84a03bcba3daed4807c064dcb234ba4f9 /Help/prop_tgt/SOURCES.rst
parent4e84a4763d702590fb06d62540e35a614dcd5133 (diff)
downloadCMake-9abd63dd3aea53008d1d01dc361a1a486215520c.zip
CMake-9abd63dd3aea53008d1d01dc361a1a486215520c.tar.gz
CMake-9abd63dd3aea53008d1d01dc361a1a486215520c.tar.bz2
Help: Explain how target SOURCES are interpreted
Co-Authored-By: Craig Scott <craig.scott@crascit.com>
Diffstat (limited to 'Help/prop_tgt/SOURCES.rst')
-rw-r--r--Help/prop_tgt/SOURCES.rst36
1 files changed, 34 insertions, 2 deletions
diff --git a/Help/prop_tgt/SOURCES.rst b/Help/prop_tgt/SOURCES.rst
index 493643e..1ebfa14 100644
--- a/Help/prop_tgt/SOURCES.rst
+++ b/Help/prop_tgt/SOURCES.rst
@@ -1,6 +1,38 @@
SOURCES
-------
-Source names specified for a target.
+This specifies the list of paths to source files for the target.
+The following commands all set or add to the ``SOURCES`` target property
+and are the usual way to manipulate it:
-List of sources specified for a target.
+* :command:`add_executable`
+* :command:`add_library`
+* :command:`add_custom_target`
+* :command:`target_sources`
+
+Contents of ``SOURCES`` may use
+:manual:`generator expressions <cmake-generator-expressions(7)>`.
+If a path starts with a generator expression, it is expected to
+evaluate to an absolute path. Not doing so is considered undefined behavior.
+
+Paths that are for files generated by the build will be treated
+as relative to the build directory of the target, if the path is not
+already specified as an absolute path. Note that whether a file is seen as
+generated may be affected by policy :policy:`CMP0118`.
+
+If a path does not start with a generator expression, is not an
+absolute path and is not a generated file, it will be treated as relative to
+the location selected by the first of the following that matches:
+
+* If a file by the specified path exists relative to the target's source
+ directory, use that file.
+* If policy :policy:`CMP0115` is not set to ``NEW``, try appending each
+ known source file extension to the path and check if that exists
+ relative to the target's source directory.
+* Repeat the above two steps, this time relative to the target's binary
+ directory instead.
+
+Note that the above decisions are made at generation time, not build time.
+
+See the :manual:`cmake-buildsystem(7)` manual for more on defining
+buildsystem properties.