summaryrefslogtreecommitdiffstats
path: root/Help/prop_tgt/SOVERSION.rst
diff options
context:
space:
mode:
authorCraig Scott <craig.scott@crascit.com>2020-03-29 10:29:17 (GMT)
committerCraig Scott <craig.scott@crascit.com>2020-03-31 09:08:29 (GMT)
commit01b47293eae07b175a005409e741facd92227c12 (patch)
treed3250b1704f446ac3665f39a58a112d822439739 /Help/prop_tgt/SOVERSION.rst
parente3185e3d1b92a95c18f22f70b3cef6944dd019eb (diff)
downloadCMake-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/SOVERSION.rst')
-rw-r--r--Help/prop_tgt/SOVERSION.rst20
1 files changed, 14 insertions, 6 deletions
diff --git a/Help/prop_tgt/SOVERSION.rst b/Help/prop_tgt/SOVERSION.rst
index d6f8a94..b377f22 100644
--- a/Help/prop_tgt/SOVERSION.rst
+++ b/Help/prop_tgt/SOVERSION.rst
@@ -21,9 +21,17 @@ Mach-O Versions
^^^^^^^^^^^^^^^
For shared libraries and executables on Mach-O systems (e.g. macOS, iOS),
-the ``SOVERSION`` property is a fallback to
-:prop_tgt:`MACHO_COMPATIBILITY_VERSION` property which corresponds to
-*compatiblity version* and :prop_tgt:`VERSION` is a fallback to
-:prop_tgt:`MACHO_CURRENT_VERSION` which corresponds 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.
+the ``SOVERSION`` property corresponds to the *compatibility version* and
+:prop_tgt:`VERSION` corresponds to the *current version* (unless Mach-O
+specific overrides are provided, as discussed below).
+See the :prop_tgt:`FRAMEWORK` target property for an example.
+
+For shared libraries, the :prop_tgt:`MACHO_COMPATIBILITY_VERSION` and
+:prop_tgt:`MACHO_CURRENT_VERSION` properties can be used to
+override the *compatibility version* and *current version* respectively.
+Note that ``SOVERSION`` will still be used to form the ``install_name``
+and both ``SOVERSION`` and :prop_tgt:`VERSION` may also affect the file
+and symlink names.
+
+Versions of Mach-O binaries may be checked with the ``otool -L <binary>``
+command.