diff options
Diffstat (limited to 'Help')
| -rw-r--r-- | Help/cpack_gen/nsis.rst | 4 | ||||
| -rw-r--r-- | Help/prop_tgt/MACHO_COMPATIBILITY_VERSION.rst | 27 | ||||
| -rw-r--r-- | Help/prop_tgt/MACHO_CURRENT_VERSION.rst | 24 | ||||
| -rw-r--r-- | Help/prop_tgt/SOVERSION.rst | 20 | ||||
| -rw-r--r-- | Help/prop_tgt/VERSION.rst | 20 | ||||
| -rw-r--r-- | Help/release/3.17.rst | 14 | ||||
| -rw-r--r-- | Help/release/dev/GoogleTest-DISCOVERY_MODE.rst | 7 | ||||
| -rw-r--r-- | Help/release/dev/GoogleTest-XML_OUTPUT_DIR.rst | 2 |
8 files changed, 90 insertions, 28 deletions
diff --git a/Help/cpack_gen/nsis.rst b/Help/cpack_gen/nsis.rst index a310e9f..d1e495f 100644 --- a/Help/cpack_gen/nsis.rst +++ b/Help/cpack_gen/nsis.rst @@ -1,7 +1,9 @@ CPack NSIS Generator -------------------- -CPack Nullsoft Scriptable Install System (NSIS) generator specific options +CPack Nullsoft Scriptable Install System (NSIS) generator specific options. + +The NSIS generator requires NSIS 3.0 or newer. Variables specific to CPack NSIS generator ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 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). diff --git a/Help/prop_tgt/MACHO_CURRENT_VERSION.rst b/Help/prop_tgt/MACHO_CURRENT_VERSION.rst index 4a1d3f0..9afb356 100644 --- a/Help/prop_tgt/MACHO_CURRENT_VERSION.rst +++ b/Help/prop_tgt/MACHO_CURRENT_VERSION.rst @@ -4,10 +4,22 @@ MACHO_CURRENT_VERSION What current version number is this target for Mach-O binaries. For shared libraries on Mach-O systems (e.g. macOS, iOS) -the :prop_tgt:`MACHO_COMPATIBILITY_VERSION` property correspond to -``compatibility version`` and ``MACHO_CURRENT_VERSION`` to ``current version``. -See the :prop_tgt:`FRAMEWORK` target property for an example. +the :prop_tgt:`MACHO_COMPATIBILITY_VERSION` property corresponds to the +*compatibility version* and ``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. -Versions of Mach-O binaries may be checked with the ``otool -L <binary>`` -command. If ``MACHO_CURRENT_VERSION`` is not set, the value of -the :prop_tgt:`VERSION` property will be used. +It should be noted that the ``MACHO_CURRENT_VERSION`` and +:prop_tgt:`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 ``MACHO_CURRENT_VERSION`` and :prop_tgt:`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 ``MACHO_CURRENT_VERSION`` and :prop_tgt:`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). 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. diff --git a/Help/prop_tgt/VERSION.rst b/Help/prop_tgt/VERSION.rst index f592f4a..95db483 100644 --- a/Help/prop_tgt/VERSION.rst +++ b/Help/prop_tgt/VERSION.rst @@ -23,9 +23,17 @@ Mach-O Versions ^^^^^^^^^^^^^^^ For shared libraries and executables on Mach-O systems (e.g. macOS, iOS), -the ``VERSION`` property is a fallback to :prop_tgt:`MACHO_CURRENT_VERSION` -property which corresponds to *current version* and :prop_tgt:`SOVERSION` -is a fallback to :prop_tgt:`MACHO_COMPATIBILITY_VERSION` which corresponds -to *compatiblity 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 :prop_tgt:`SOVERSION` property corresponds to the *compatibility version* +and ``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 :prop_tgt:`SOVERSION` will still be used to form the +``install_name`` and both :prop_tgt:`SOVERSION` and ``VERSION`` may also +affect the file and symlink names. + +Versions of Mach-O binaries may be checked with the ``otool -L <binary>`` +command. diff --git a/Help/release/3.17.rst b/Help/release/3.17.rst index c2cfdf0..7c5b44d 100644 --- a/Help/release/3.17.rst +++ b/Help/release/3.17.rst @@ -282,6 +282,8 @@ Deprecated and Removed Features option and cannot be fixed without breaking compatibility, and so have been superseded. +* The :cpack_gen:`CPack NSIS Generator` now requires NSIS 3.0 or later. + Other Changes ============= @@ -319,3 +321,15 @@ Other Changes * The :generator:`Xcode` generator no longer hard-codes ``-Wmost``, ``-Wno-four-char-constants``, and ``-Wno-unknown-pragmas`` warning flags. + +Updates +======= + +Changes made since CMake 3.17.0 include the following. + +3.17.1 +------ + +* CMake 3.17.0 updated the :cpack_gen:`CPack NSIS Generator` with changes + that require NSIS 3.0 or later. CMake 3.17.1 now enforces the use + of a sufficiently new version. diff --git a/Help/release/dev/GoogleTest-DISCOVERY_MODE.rst b/Help/release/dev/GoogleTest-DISCOVERY_MODE.rst new file mode 100644 index 0000000..7bc2f14 --- /dev/null +++ b/Help/release/dev/GoogleTest-DISCOVERY_MODE.rst @@ -0,0 +1,7 @@ +GoogleTest-DISCOVERY_MODE +------------------------- + +* The :module:`GoogleTest` module :command:`gtest_discover_tests` command + gained a new ``DISCOVERY_MODE`` option to control when the test + discovery step is run. It offers a new ``PRE_TEST`` setting to + run the discovery at test time instead of build time. diff --git a/Help/release/dev/GoogleTest-XML_OUTPUT_DIR.rst b/Help/release/dev/GoogleTest-XML_OUTPUT_DIR.rst index ee29e60..e8aba01 100644 --- a/Help/release/dev/GoogleTest-XML_OUTPUT_DIR.rst +++ b/Help/release/dev/GoogleTest-XML_OUTPUT_DIR.rst @@ -1,6 +1,6 @@ GoogleTest-XML_OUTPUT_DIR ------------------------- -* The :module:`GoogleTest` module ``gtest_discover_test`` command +* The :module:`GoogleTest` module :command:`gtest_discover_tests` command gained a new optional parameter ``XML_OUTPUT_DIR``. When set the JUnit XML test results are stored in that directory. |