summaryrefslogtreecommitdiffstats
path: root/Help
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2018-05-08 12:20:34 (GMT)
committerKitware Robot <kwrobot@kitware.com>2018-05-08 12:21:27 (GMT)
commitf1344ca2adbca2ec2385886eeed65bf01966be8f (patch)
treef8bbd7d099d1ffae59936bf8674afd33c123b997 /Help
parent14bfd267e5e7498f0131b87e54c11cafa2ff6903 (diff)
parente15adbfed322a7db218a82108cba26bcba57b30c (diff)
downloadCMake-f1344ca2adbca2ec2385886eeed65bf01966be8f.zip
CMake-f1344ca2adbca2ec2385886eeed65bf01966be8f.tar.gz
CMake-f1344ca2adbca2ec2385886eeed65bf01966be8f.tar.bz2
Merge topic 'doc-updates'
e15adbfed3 Help: Specify COMPILE_OPTIONS and COMPILE_FLAGS source properties usage Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !2043
Diffstat (limited to 'Help')
-rw-r--r--Help/prop_sf/COMPILE_FLAGS.rst10
-rw-r--r--Help/prop_sf/COMPILE_OPTIONS.rst4
2 files changed, 11 insertions, 3 deletions
diff --git a/Help/prop_sf/COMPILE_FLAGS.rst b/Help/prop_sf/COMPILE_FLAGS.rst
index be81cf6..c211b89 100644
--- a/Help/prop_sf/COMPILE_FLAGS.rst
+++ b/Help/prop_sf/COMPILE_FLAGS.rst
@@ -3,9 +3,9 @@ COMPILE_FLAGS
Additional flags to be added when compiling this source file.
-The ``COMPILE_FLAGS`` property sets additional compiler flags used to build
-source files. Use :prop_sf:`COMPILE_DEFINITIONS` to pass additional
-preprocessor definitions.
+The ``COMPILE_FLAGS`` property, managed as a string, sets additional compiler
+flags used to build source files. Use :prop_sf:`COMPILE_DEFINITIONS` to pass
+additional preprocessor definitions.
Contents of ``COMPILE_FLAGS`` may use "generator expressions"
with the syntax ``$<...>``. See the :manual:`cmake-generator-expressions(7)`
@@ -13,3 +13,7 @@ manual for available expressions. However, :generator:`Xcode`
does not support per-config per-source settings, so expressions
that depend on the build configuration are not allowed with that
generator.
+
+.. note::
+
+ This property has been superseded by the :prop_sf:`COMPILE_OPTIONS` property.
diff --git a/Help/prop_sf/COMPILE_OPTIONS.rst b/Help/prop_sf/COMPILE_OPTIONS.rst
index 157c0b0..3b2bc8d 100644
--- a/Help/prop_sf/COMPILE_OPTIONS.rst
+++ b/Help/prop_sf/COMPILE_OPTIONS.rst
@@ -15,3 +15,7 @@ for available expressions. However, :generator:`Xcode`
does not support per-config per-source settings, so expressions
that depend on the build configuration are not allowed with that
generator.
+
+.. note::
+
+ This property should be preferred over the :prop_sf:`COMPILE_FLAGS` property.