mirror of
https://github.com/Kitware/CMake.git
synced 2026-02-21 22:50:26 -06:00
c705279bae
This change ony concerns directives that appear in the document body. The guidelines for inserting version directives: * Baseline version is CMake 3.0, i.e. directives start at 3.1. * Always use `.. versionadded::` directive, avoid ad-hoc version references. Exception: policy pages. * For new command signatures, put `versionadded` on a separate line after the signature. * For a group of new signatures in a new document section, a single version note at the beginning of the section is sufficient. * For new options, put `versionadded` on a separate line before option description. * If all the option descriptions in the list are short one-liners, it's fine to put `versionadded` on the same line as the description. * If multiple option descriptions in close proximity would have the same ..versionadded directive, consider adding a single directive after the list, mentioning all added options. * For compact value lists and sub-option lists, put a single `versionadded` directive after the list mentioning all additions. * When a change is described in a single paragraph, put `versionadded` into that paragraph. * When only part of the paragraph has changed, separate the changed part if it doesn't break the flow. Otherwise, write a follow-up clarification paragraph and apply version directive to that. * When multiple version directives are close by, order earlier additions before later additions. * Indent related lists and code blocks to include them in the scope of `versionadded` directive. Issue: #19715
42 lines
1.7 KiB
ReStructuredText
42 lines
1.7 KiB
ReStructuredText
target_compile_definitions
|
|
--------------------------
|
|
|
|
Add compile definitions to a target.
|
|
|
|
.. code-block:: cmake
|
|
|
|
target_compile_definitions(<target>
|
|
<INTERFACE|PUBLIC|PRIVATE> [items1...]
|
|
[<INTERFACE|PUBLIC|PRIVATE> [items2...] ...])
|
|
|
|
Specifies compile definitions 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>`.
|
|
|
|
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_DEFINITIONS` property of
|
|
``<target>``. ``PUBLIC`` and ``INTERFACE`` items will populate the
|
|
:prop_tgt:`INTERFACE_COMPILE_DEFINITIONS` property of ``<target>``.
|
|
The following arguments specify compile definitions. Repeated calls for the
|
|
same ``<target>`` append items in the order called.
|
|
|
|
.. versionadded:: 3.11
|
|
Allow setting ``INTERFACE`` items on :ref:`IMPORTED targets <Imported Targets>`.
|
|
|
|
Arguments to ``target_compile_definitions`` 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.
|
|
|
|
Any leading ``-D`` on an item will be removed. Empty items are ignored.
|
|
For example, the following are all equivalent:
|
|
|
|
.. code-block:: cmake
|
|
|
|
target_compile_definitions(foo PUBLIC FOO)
|
|
target_compile_definitions(foo PUBLIC -DFOO) # -D removed
|
|
target_compile_definitions(foo PUBLIC "" FOO) # "" ignored
|
|
target_compile_definitions(foo PUBLIC -D FOO) # -D becomes "", then ignored
|