summaryrefslogtreecommitdiffstats
path: root/Help/prop_tgt/COMPILE_DEFINITIONS.rst
diff options
context:
space:
mode:
authorStephen Kelly <steveire@gmail.com>2014-02-05 13:51:08 (GMT)
committerBrad King <brad.king@kitware.com>2014-02-06 21:15:53 (GMT)
commit3879c847825d40a439b0ec55421309ab9b33c1ee (patch)
tree42f3d3b7a615b5aed7e253c7468bfd8c8369fabf /Help/prop_tgt/COMPILE_DEFINITIONS.rst
parentba4c2fa8fd2a03f7d69e60d581d44a3cc79a3c9a (diff)
downloadCMake-3879c847825d40a439b0ec55421309ab9b33c1ee.zip
CMake-3879c847825d40a439b0ec55421309ab9b33c1ee.tar.gz
CMake-3879c847825d40a439b0ec55421309ab9b33c1ee.tar.bz2
Help: Document relation of properties to the rest of the buildsystem.
Diffstat (limited to 'Help/prop_tgt/COMPILE_DEFINITIONS.rst')
-rw-r--r--Help/prop_tgt/COMPILE_DEFINITIONS.rst19
1 files changed, 11 insertions, 8 deletions
diff --git a/Help/prop_tgt/COMPILE_DEFINITIONS.rst b/Help/prop_tgt/COMPILE_DEFINITIONS.rst
index 81e73a4..00c49c3 100644
--- a/Help/prop_tgt/COMPILE_DEFINITIONS.rst
+++ b/Help/prop_tgt/COMPILE_DEFINITIONS.rst
@@ -3,21 +3,24 @@ COMPILE_DEFINITIONS
Preprocessor definitions for compiling a target's sources.
-The COMPILE_DEFINITIONS property may be set to a semicolon-separated
-list of preprocessor definitions using the syntax VAR or VAR=value.
+The ``COMPILE_DEFINITIONS`` property may be set to a semicolon-separated
+list of preprocessor definitions using the syntax ``VAR`` or ``VAR=value``.
Function-style definitions are not supported. CMake will
automatically escape the value correctly for the native build system
(note that CMake language syntax may require escapes to specify some
-values). This property may be set on a per-configuration basis using
-the name COMPILE_DEFINITIONS_<CONFIG> where <CONFIG> is an upper-case
-name (ex. "COMPILE_DEFINITIONS_DEBUG").
+values).
CMake will automatically drop some definitions that are not supported
by the native build tool. The VS6 IDE does not support definition
values with spaces (but NMake does).
-Contents of COMPILE_DEFINITIONS may use "generator expressions" with the
+.. include:: /include/COMPILE_DEFINITIONS_DISCLAIMER.txt
+
+Contents of ``COMPILE_DEFINITIONS`` may use "generator expressions" with the
syntax ``$<...>``. See the :manual:`cmake-generator-expressions(7)` manual
-for available expressions.
+for available expressions. See the :manual:`cmake-buildsystem(7)` manual
+for more on defining buildsystem properties.
-.. include:: /include/COMPILE_DEFINITIONS_DISCLAIMER.txt
+The corresponding :prop_tgt:`COMPILE_DEFINITIONS_<CONFIG>` property may
+be set to specify per-configuration definitions. Generator expressions
+should be preferred instead of setting the alternative property.