mirror/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2026-01-05 13:20:47 -06:00
Code Issues Packages Projects Releases Wiki Activity

Help: Update cmake-buildsystem documentation

Browse Source 
Add additional information to the cmake-buildsystem manual:

* Add link to "Generator Expressions" in a place which demonstrates a
  generator expression without linking to what they are.
* Update "diagnostic message" for "Compatible Interface Properties" to
  contain an example of the message sent.
* Add information about the macOS FRAMEWORK_VERSION and how "A" is the
  conventional value to use.
This commit is contained in:
Joseph Snyder
2020-08-12 09:30:04 -04:00
committed by Brad King
parent 514292ab0f
commit cfcb71c530
1 changed files with 15 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
Help/manual/cmake-buildsystem.7.rst
View File

@@ -96,6 +96,9 @@ Apple Frameworks
A ``SHARED`` library may be marked with the :prop_tgt:`FRAMEWORK` A ``SHARED`` library may be marked with the :prop_tgt:`FRAMEWORK`
target property to create an macOS or iOS Framework Bundle. target property to create an macOS or iOS Framework Bundle.
A library with the ``FRAMEWORK`` target property should also set the
:prop_tgt:`FRAMEWORK_VERSION` target property. This property is typically
set to the value of "A" by macOS conventions.
The ``MACOSX_FRAMEWORK_IDENTIFIER`` sets ``CFBundleIdentifier`` key The ``MACOSX_FRAMEWORK_IDENTIFIER`` sets ``CFBundleIdentifier`` key
and it uniquely identifies the bundle. and it uniquely identifies the bundle.
@@ -104,7 +107,7 @@ and it uniquely identifies the bundle.
add_library(MyFramework SHARED MyFramework.cpp) add_library(MyFramework SHARED MyFramework.cpp)
set_target_properties(MyFramework PROPERTIES set_target_properties(MyFramework PROPERTIES
FRAMEWORK TRUE FRAMEWORK TRUE
FRAMEWORK_VERSION A FRAMEWORK_VERSION A # Version "A" is macOS convention
MACOSX_FRAMEWORK_IDENTIFIER org.cmake.MyFramework MACOSX_FRAMEWORK_IDENTIFIER org.cmake.MyFramework
) )
@@ -115,7 +118,10 @@ Object Libraries
The ``OBJECT`` library type defines a non-archival collection of object files The ``OBJECT`` library type defines a non-archival collection of object files
resulting from compiling the given source files. The object files collection resulting from compiling the given source files. The object files collection
may be used as source inputs to other targets: may be used as source inputs to other targets by using the syntax
``$<TARGET_OBJECTS:name>``. This is a
:manual:`generator expression <cmake-generator-expressions(7)>` that can be
used to supply the ``OBJECT`` library content to other targets:
.. code-block:: cmake .. code-block:: cmake
@@ -373,8 +379,12 @@ position-independent-code, so a diagnostic is issued.
The ``lib1`` and ``lib2`` requirements are not "compatible". One of them The ``lib1`` and ``lib2`` requirements are not "compatible". One of them
requires that consumers are built as position-independent-code, while requires that consumers are built as position-independent-code, while
the other requires that consumers are not built as position-independent-code. the other requires that consumers are not built as position-independent-code.
Because ``exe2`` links to both and they are in conflict, a diagnostic is Because ``exe2`` links to both and they are in conflict, a CMake error message
issued. is issued::
CMake Error: The INTERFACE_POSITION_INDEPENDENT_CODE property of "lib2" does
not agree with the value of POSITION_INDEPENDENT_CODE already determined
for "exe2".
To be "compatible", the :prop_tgt:`POSITION_INDEPENDENT_CODE` property, To be "compatible", the :prop_tgt:`POSITION_INDEPENDENT_CODE` property,
if set must be either the same, in a boolean sense, as the if set must be either the same, in a boolean sense, as the
@@ -732,7 +742,7 @@ As the value of the :prop_tgt:`POSITION_INDEPENDENT_CODE` property of
the ``exe1`` target is dependent on the linked libraries (``lib3``), and the the ``exe1`` target is dependent on the linked libraries (``lib3``), and the
edge of linking ``exe1`` is determined by the same edge of linking ``exe1`` is determined by the same
:prop_tgt:`POSITION_INDEPENDENT_CODE` property, the dependency graph above :prop_tgt:`POSITION_INDEPENDENT_CODE` property, the dependency graph above
contains a cycle. :manual:`cmake(1)` issues a diagnostic in this case. contains a cycle. :manual:`cmake(1)` issues an error message.
.. _`Output Artifacts`: .. _`Output Artifacts`: