diff options
| author | Craig Scott <craig.scott@crascit.com> | 2020-03-29 10:29:17 (GMT) |
|---|---|---|
| committer | Craig Scott <craig.scott@crascit.com> | 2020-03-31 09:08:29 (GMT) |
| commit | 01b47293eae07b175a005409e741facd92227c12 (patch) | |
| tree | d3250b1704f446ac3665f39a58a112d822439739 /Help/prop_tgt/MACHO_COMPATIBILITY_VERSION.rst | |
| parent | e3185e3d1b92a95c18f22f70b3cef6944dd019eb (diff) | |
| download | CMake-01b47293eae07b175a005409e741facd92227c12.zip CMake-01b47293eae07b175a005409e741facd92227c12.tar.gz CMake-01b47293eae07b175a005409e741facd92227c12.tar.bz2 | |
Help: Fix inaccuracies and omissions in MACHO_* property docs
The VERSION and SOVERSION properties are not true fallbacks for
the MACHO_* properties since the MACHO_* properties only affect
the embedded version information, but VERSION and SOVERSION
also affect other things.
Diffstat (limited to 'Help/prop_tgt/MACHO_COMPATIBILITY_VERSION.rst')
| -rw-r--r-- | Help/prop_tgt/MACHO_COMPATIBILITY_VERSION.rst | 27 |
1 files changed, 19 insertions, 8 deletions
diff --git a/Help/prop_tgt/MACHO_COMPATIBILITY_VERSION.rst b/Help/prop_tgt/MACHO_COMPATIBILITY_VERSION.rst index f3fedba..26d5cc8 100644 --- a/Help/prop_tgt/MACHO_COMPATIBILITY_VERSION.rst +++ b/Help/prop_tgt/MACHO_COMPATIBILITY_VERSION.rst @@ -4,11 +4,22 @@ MACHO_COMPATIBILITY_VERSION What compatibility version number is this target for Mach-O binaries. For shared libraries on Mach-O systems (e.g. macOS, iOS) -the ``MACHO_COMPATIBILITY_VERSION`` property correspond to -``compatibility version`` and :prop_tgt:`MACHO_CURRENT_VERSION` to -``current version``. -See the :prop_tgt:`FRAMEWORK` target property for an example. - -Versions of Mach-O binaries may be checked with the ``otool -L <binary>`` -command. If ``MACHO_COMPATIBILITY_VERSION`` is not set, the value of -the :prop_tgt:`SOVERSION` property will be used. +the ``MACHO_COMPATIBILITY_VERSION`` property corresponds to the +*compatibility version* and :prop_tgt:`MACHO_CURRENT_VERSION` corresponds to +the *current version*. These are both embedded in the shared library binary +and can be checked with the ``otool -L <binary>`` command. + +It should be noted that the :prop_tgt:`MACHO_CURRENT_VERSION` and +``MACHO_COMPATIBILITY_VERSION`` properties do not affect the file +names or version-related symlinks that CMake generates for the library. +The :prop_tgt:`VERSION` and :prop_tgt:`SOVERSION` target properties still +control the file and symlink names. The ``install_name`` is also still +controlled by :prop_tgt:`SOVERSION`. + +When :prop_tgt:`MACHO_CURRENT_VERSION` and ``MACHO_COMPATIBILITY_VERSION`` +are not given, :prop_tgt:`VERSION` and :prop_tgt:`SOVERSION` are used for +the version details to be embedded in the binaries respectively. +The :prop_tgt:`MACHO_CURRENT_VERSION` and ``MACHO_COMPATIBILITY_VERSION`` +properties only need to be given if the project needs to decouple the file +and symlink naming from the version details embedded in the binaries +(e.g. to match libtool conventions). |