mirror of
https://github.com/Kitware/CMake.git
synced 2026-01-05 13:20:47 -06:00
Options specified via `COMPILE_OPTIONS` and `INTERFACE_COMPILE_OPTIONS`
are deduplicated, but individual options can legitimately be duplicated
when grouped with other options, e.g.
-D A -D B
After deduplication that becomes `-D A B`. Therefore we need a way to
treat groups of options as units during deduplication. A simple approach
is to specify each group as one option, e.g.
"-D A" "-D B"
However, that conflicts with options that legitimately have spaces. To
break this ambiguity, add a `SHELL:` prefix syntax to specify that an
option should be parsed like shell command line arguments after
deduplication, e.g.
"SHELL:-D A" "SHELL:-D B"
These will survive deduplication intact, and then be parsed to produce
`-D A -D B` on the final command line.
Fixes: #15826
43 lines
1.8 KiB
ReStructuredText
43 lines
1.8 KiB
ReStructuredText
target_compile_options
|
|
----------------------
|
|
|
|
Add compile options to a target.
|
|
|
|
::
|
|
|
|
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
|
|
:command:`add_executable` or :command:`add_library` and must not be an
|
|
:ref:`ALIAS target <Alias Targets>`.
|
|
|
|
If ``BEFORE`` is specified, the content will be prepended to the property
|
|
instead of being appended.
|
|
|
|
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_dir:`directory <COMPILE_OPTIONS>` and
|
|
:prop_tgt:`target <COMPILE_OPTIONS>` ``COMPILE_OPTIONS`` properties.
|
|
|
|
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>``.
|
|
(:ref:`IMPORTED targets <Imported Targets>` only support ``INTERFACE`` items.)
|
|
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.
|
|
|
|
.. include:: COMPILE_OPTIONS_SHELL.txt
|