summaryrefslogtreecommitdiffstats
path: root/Help
diff options
context:
space:
mode:
authorJoachim Wuttke (h) <j.wuttke@fz-juelich.de>2020-05-14 20:05:30 (GMT)
committerJoachim Wuttke (h) <j.wuttke@fz-juelich.de>2020-05-14 20:05:30 (GMT)
commit1f697b399131770eb4a1e2cb4951d33583c7261f (patch)
tree35a2eb1da40fe02247b57a1f0d87f54ecca36024 /Help
parentae9614a22d5e39882b2a686e8229170a8296212d (diff)
downloadCMake-1f697b399131770eb4a1e2cb4951d33583c7261f.zip
CMake-1f697b399131770eb4a1e2cb4951d33583c7261f.tar.gz
CMake-1f697b399131770eb4a1e2cb4951d33583c7261f.tar.bz2
Help: COMPILE_OPTIONS: bundle cross refs, add example
Diffstat (limited to 'Help')
-rw-r--r--Help/prop_sf/COMPILE_OPTIONS.rst16
1 files changed, 11 insertions, 5 deletions
diff --git a/Help/prop_sf/COMPILE_OPTIONS.rst b/Help/prop_sf/COMPILE_OPTIONS.rst
index 7e48271..cc61d9c 100644
--- a/Help/prop_sf/COMPILE_OPTIONS.rst
+++ b/Help/prop_sf/COMPILE_OPTIONS.rst
@@ -5,9 +5,7 @@ List of additional options to pass to the compiler.
This property holds a :ref:`semicolon-separated list <CMake Language Lists>` of options
and will be added to the list of compile flags when this
-source file builds. Use :prop_sf:`COMPILE_DEFINITIONS` to pass
-additional preprocessor definitions and :prop_sf:`INCLUDE_DIRECTORIES` to pass
-additional include directories.
+source file builds.
Contents of ``COMPILE_OPTIONS`` may use "generator expressions" with the
syntax ``$<...>``. See the :manual:`cmake-generator-expressions(7)` manual
@@ -16,6 +14,14 @@ does not support per-config per-source settings, so expressions
that depend on the build configuration are not allowed with that
generator.
-.. note::
+Usage example:
- This property should be preferred over the :prop_sf:`COMPILE_FLAGS` property.
+.. code-block:: cmake
+
+ set_source_files_properties(foo.cpp PROPERTIES COMPILE_OPTIONS "-Wno-unused-parameter;-Wno-missing-field-initializer")
+
+Related properties:
+
+* Prefer this property over :prop_sf:`COMPILE_FLAGS`.
+* Use :prop_sf:`COMPILE_DEFINITIONS` to pass additional preprocessor definitions.
+* Use :prop_sf:`INCLUDE_DIRECTORIES` to pass additional include directories.