target_link_options.rst 2.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354
  1. target_link_options
  2. -------------------
  3. .. versionadded:: 3.13
  4. Add options to the link step for an executable, shared library or module
  5. library target.
  6. .. code-block:: cmake
  7. target_link_options(<target> [BEFORE]
  8. <INTERFACE|PUBLIC|PRIVATE> [items1...]
  9. [<INTERFACE|PUBLIC|PRIVATE> [items2...] ...])
  10. The named ``<target>`` must have been created by a command such as
  11. :command:`add_executable` or :command:`add_library` and must not be an
  12. :ref:`ALIAS target <Alias Targets>`.
  13. This command can be used to add any link options, but alternative commands
  14. exist to add libraries (:command:`target_link_libraries` or
  15. :command:`link_libraries`). See documentation of the
  16. :prop_dir:`directory <LINK_OPTIONS>` and
  17. :prop_tgt:`target <LINK_OPTIONS>` ``LINK_OPTIONS`` properties.
  18. .. note::
  19. This command cannot be used to add options for static library targets,
  20. since they do not use a linker. To add archiver or MSVC librarian flags,
  21. see the :prop_tgt:`STATIC_LIBRARY_OPTIONS` target property.
  22. If ``BEFORE`` is specified, the content will be prepended to the property
  23. instead of being appended.
  24. The ``INTERFACE``, ``PUBLIC`` and ``PRIVATE`` keywords are required to
  25. specify the :ref:`scope <Target Usage Requirements>` of the following arguments.
  26. ``PRIVATE`` and ``PUBLIC`` items will populate the :prop_tgt:`LINK_OPTIONS`
  27. property of ``<target>``. ``PUBLIC`` and ``INTERFACE`` items will populate the
  28. :prop_tgt:`INTERFACE_LINK_OPTIONS` property of ``<target>``.
  29. The following arguments specify link options. Repeated calls for the same
  30. ``<target>`` append items in the order called.
  31. .. note::
  32. :ref:`IMPORTED targets <Imported Targets>` only support ``INTERFACE`` items.
  33. Arguments to ``target_link_options`` may use "generator expressions"
  34. with the syntax ``$<...>``. See the :manual:`cmake-generator-expressions(7)`
  35. manual for available expressions. See the :manual:`cmake-buildsystem(7)`
  36. manual for more on defining buildsystem properties.
  37. .. include:: DEVICE_LINK_OPTIONS.txt
  38. .. include:: OPTIONS_SHELL.txt
  39. .. include:: LINK_OPTIONS_LINKER.txt