summaryrefslogtreecommitdiffstats
path: root/Help/command/target_compile_options.rst
diff options
context:
space:
mode:
authorStephen Kelly <steveire@gmail.com>2014-02-03 13:20:42 (GMT)
committerBrad King <brad.king@kitware.com>2014-02-06 21:15:53 (GMT)
commitba4c2fa8fd2a03f7d69e60d581d44a3cc79a3c9a (patch)
treef44187babf7f2eb84c5532789783a6d5a6bbdeee /Help/command/target_compile_options.rst
parenta683262a727c4fd2c9e3271e6bc36679d0963342 (diff)
downloadCMake-ba4c2fa8fd2a03f7d69e60d581d44a3cc79a3c9a.zip
CMake-ba4c2fa8fd2a03f7d69e60d581d44a3cc79a3c9a.tar.gz
CMake-ba4c2fa8fd2a03f7d69e60d581d44a3cc79a3c9a.tar.bz2
Help: Mark up the buildsystem commands documentation
Cross-link to the cmake-buildsystem manual.
Diffstat (limited to 'Help/command/target_compile_options.rst')
-rw-r--r--Help/command/target_compile_options.rst40
1 files changed, 25 insertions, 15 deletions
diff --git a/Help/command/target_compile_options.rst b/Help/command/target_compile_options.rst
index 3870abf..0fdeba6 100644
--- a/Help/command/target_compile_options.rst
+++ b/Help/command/target_compile_options.rst
@@ -5,23 +5,33 @@ Add compile options to a target.
::
- target_compile_options(<target> [BEFORE] <INTERFACE|PUBLIC|PRIVATE> [items1...]
+ target_compile_options(<target> [BEFORE]
+ <INTERFACE|PUBLIC|PRIVATE> [items1...]
[<INTERFACE|PUBLIC|PRIVATE> [items2...] ...])
Specify compile options to use when compiling a given target. The
-named <target> must have been created by a command such as
-add_executable or add_library and must not be an IMPORTED target. If
-BEFORE is specified, the content will be prepended to the property
-instead of being appended.
+named ``<target>`` must have been created by a command such as
+:command:`add_executable` or :command:`add_library` and must not be an
+:prop_tgt:`IMPORTED Target`. If ``BEFORE`` is specified, the content will
+be prepended to the property instead of being appended.
-The INTERFACE, PUBLIC and PRIVATE keywords are required to specify the
-scope of the following arguments. PRIVATE and PUBLIC items will
-populate the COMPILE_OPTIONS property of <target>. PUBLIC and
-INTERFACE items will populate the INTERFACE_COMPILE_OPTIONS property
-of <target>. The following arguments specify compile options.
-Repeated calls for the same <target> append items in the order called.
+This command can be used to add any options, but
+alternative commands exist to add preprocessor definitions
+(:command:`target_compile_definitions` and :command:`add_definitions`) or
+include directories (:command:`target_include_directories` and
+:command:`include_directories`). See documentation of the
+:prop_tgt:`directory <COMPILE_OPTIONS>` and
+:prop_tgt:` target <COMPILE_OPTIONS>` ``COMPILE_OPTIONS`` properties.
-Arguments to target_compile_options may use "generator expressions"
-with the syntax ``$<...>``.
-See the :manual:`cmake-generator-expressions(7)` manual for available
-expressions.
+The ``INTERFACE``, ``PUBLIC`` and ``PRIVATE`` keywords are required to
+specify the scope of the following arguments. ``PRIVATE`` and ``PUBLIC``
+items will populate the :prop_tgt:`COMPILE_OPTIONS` property of
+``<target>``. ``PUBLIC`` and ``INTERFACE`` items will populate the
+:prop_tgt:`INTERFACE_COMPILE_OPTIONS` property of ``<target>``. The
+following arguments specify compile options. Repeated calls for the same
+``<target>`` append items in the order called.
+
+Arguments to ``target_compile_options`` may use "generator expressions"
+with the syntax ``$<...>``. See the :manual:`cmake-generator-expressions(7)`
+manual for available expressions. See the :manual:`cmake-buildsystem(7)`
+manual for more on defining buildsystem properties.