diff --git a/Help/command/cmake_parse_arguments.rst b/Help/command/cmake_parse_arguments.rst index 8dedc80108..7c85da6103 100644 --- a/Help/command/cmake_parse_arguments.rst +++ b/Help/command/cmake_parse_arguments.rst @@ -1,8 +1,6 @@ cmake_parse_arguments --------------------- -.. versionadded:: 3.5 - Parse function or macro arguments. .. code-block:: cmake @@ -13,6 +11,10 @@ Parse function or macro arguments. cmake_parse_arguments(PARSE_ARGV ) +.. versionadded:: 3.5 + This command is implemented natively. Previously, it has been defined in the + module :module:`CMakeParseArguments`. + This command is for use in macros or functions. It processes the arguments given to that macro or function, and defines a set of variables which hold the values of the diff --git a/Help/command/ctest_submit.rst b/Help/command/ctest_submit.rst index 9c1031819b..e6d277f59d 100644 --- a/Help/command/ctest_submit.rst +++ b/Help/command/ctest_submit.rst @@ -115,16 +115,16 @@ to tell CDash which handler to use to process the data. This signature interprets options in the same way as the first one. .. versionadded:: 3.8 - Added ``RETRY_COUNT``, ``RETRY_DELAY``, ``QUIET`` options. + Added the ``RETRY_COUNT``, ``RETRY_DELAY``, ``QUIET`` options. .. versionadded:: 3.9 - Added ``HTTPHEADER`` option. + Added the ``HTTPHEADER`` option. .. versionadded:: 3.13 - Added ``RETURN_VALUE`` option. + Added the ``RETURN_VALUE`` option. .. versionadded:: 3.14 - Added ``SUBMIT_URL`` option. + Added the ``SUBMIT_URL`` option. .. versionadded:: 3.15 - Added ``BUILD_ID`` option. + Added the ``BUILD_ID`` option. diff --git a/Help/command/file.rst b/Help/command/file.rst index 9580c9cf1d..6837672576 100644 --- a/Help/command/file.rst +++ b/Help/command/file.rst @@ -126,7 +126,7 @@ Parse a list of ASCII strings from ```` and store it in the ``ENCODING`` option will be defaulted to respect the Byte Order Mark. .. versionadded:: 3.2 - Added ``UTF-16LE``, ``UTF-16BE``, ``UTF-32LE``, ``UTF-32BE`` encodings. + Added the ``UTF-16LE``, ``UTF-16BE``, ``UTF-32LE``, ``UTF-32BE`` encodings. For example, the code diff --git a/Help/command/find_package.rst b/Help/command/find_package.rst index 2ef3e97b87..3dfd62fc32 100644 --- a/Help/command/find_package.rst +++ b/Help/command/find_package.rst @@ -432,7 +432,7 @@ enabled. hard-coded guesses. .. versionadded:: 3.16 - Added ``CMAKE_FIND_USE__PATH`` variables to globally disable + Added the ``CMAKE_FIND_USE__PATH`` variables to globally disable various search locations. .. |FIND_XXX| replace:: find_package diff --git a/Help/command/get_filename_component.rst b/Help/command/get_filename_component.rst index e073a28c05..be9d00af30 100644 --- a/Help/command/get_filename_component.rst +++ b/Help/command/get_filename_component.rst @@ -25,7 +25,7 @@ Sets ```` to a component of ````, where ```` is one of: PATH = Legacy alias for DIRECTORY (use for CMake <= 2.8.11) .. versionadded:: 3.14 - Added ``LAST_EXT`` and ``NAME_WLE`` modes. + Added the ``LAST_EXT`` and ``NAME_WLE`` modes. Paths are returned with forward slashes and have no trailing slashes. If the optional ``CACHE`` argument is specified, the result variable is diff --git a/Help/command/list.rst b/Help/command/list.rst index ee3530c51b..7accc5a39e 100644 --- a/Help/command/list.rst +++ b/Help/command/list.rst @@ -318,10 +318,10 @@ Reverses the contents of the list in-place. Sorts the list in-place alphabetically. .. versionadded:: 3.13 - Added ``COMPARE``, ``CASE``, and ``ORDER`` options. + Added the ``COMPARE``, ``CASE``, and ``ORDER`` options. .. versionadded:: 3.18 - Added ``COMPARE NATURAL`` option. + Added the ``COMPARE NATURAL`` option. Use the ``COMPARE`` keyword to select the comparison method for sorting. The ```` option should be one of: diff --git a/Help/command/message.rst b/Help/command/message.rst index 3ea82a63b9..e44803e858 100644 --- a/Help/command/message.rst +++ b/Help/command/message.rst @@ -72,7 +72,7 @@ influences the way the message is handled: removed before releasing the project, packaging up the files, etc. .. versionadded:: 3.15 - Added ``NOTICE``, ``VERBOSE``, ``DEBUG``, and ``TRACE`` levels. + Added the ``NOTICE``, ``VERBOSE``, ``DEBUG``, and ``TRACE`` levels. The CMake command-line tool displays ``STATUS`` to ``TRACE`` messages on stdout with the message preceded by two hyphens and a space. All other message types diff --git a/Help/command/project.rst b/Help/command/project.rst index d3454cc47a..6c931b692a 100644 --- a/Help/command/project.rst +++ b/Help/command/project.rst @@ -76,7 +76,7 @@ The options are: then the description is also stored in the variable :variable:`CMAKE_PROJECT_DESCRIPTION`. .. versionadded:: 3.12 - Added ``_DESCRIPTION`` variable. + Added the ``_DESCRIPTION`` variable. ``HOMEPAGE_URL `` .. versionadded:: 3.12 @@ -120,8 +120,6 @@ options are intended for use as default values in package metadata and documenta Code Injection ^^^^^^^^^^^^^^ -.. versionadded:: 3.15 - If the :variable:`CMAKE_PROJECT_INCLUDE_BEFORE` or :variable:`CMAKE_PROJECT__INCLUDE_BEFORE` variables are set, the files they point to will be included as the first step of the @@ -135,8 +133,12 @@ they point to will be included as the last step of the ``project()`` command. If both are set, then :variable:`CMAKE_PROJECT_INCLUDE` will be included before :variable:`CMAKE_PROJECT__INCLUDE`. +.. versionadded:: 3.15 + Added the ``CMAKE_PROJECT_INCLUDE`` and ``CMAKE_PROJECT_INCLUDE_BEFORE`` + variables. + .. versionadded:: 3.17 - Added ``CMAKE_PROJECT__INCLUDE_BEFORE`` variable. + Added the ``CMAKE_PROJECT__INCLUDE_BEFORE`` variable. Usage ^^^^^ diff --git a/Help/command/string.rst b/Help/command/string.rst index 178d9d3ef5..8ad0089afd 100644 --- a/Help/command/string.rst +++ b/Help/command/string.rst @@ -335,7 +335,7 @@ Comparison Compare the strings and store true or false in the ````. .. versionadded:: 3.7 - Added ``LESS_EQUAL`` and ``GREATER_EQUAL`` options. + Added the ``LESS_EQUAL`` and ``GREATER_EQUAL`` options. .. _`Supported Hash Algorithms`: @@ -373,7 +373,7 @@ The supported ```` algorithm names are: Keccak SHA-3. .. versionadded:: 3.8 - Added ``SHA3`` hash algorithms. + Added the ``SHA3_*`` hash algorithms. Generation ^^^^^^^^^^ diff --git a/Help/cpack_gen/deb.rst b/Help/cpack_gen/deb.rst index 8fbefdb37a..7cae613779 100644 --- a/Help/cpack_gen/deb.rst +++ b/Help/cpack_gen/deb.rst @@ -224,7 +224,7 @@ List of CPack DEB generator specific variables: Per-component ``CPACK_DEBIAN__DESCRIPTION`` variables. .. versionadded:: 3.16 - ``CPACK_PACKAGE_DESCRIPTION_FILE`` variable. + The ``CPACK_PACKAGE_DESCRIPTION_FILE`` variable. .. _Debian Policy Manual: https://www.debian.org/doc/debian-policy/ch-controlfields.html#description @@ -303,7 +303,7 @@ List of CPack DEB generator specific variables: * Default : :variable:`CMAKE_PROJECT_HOMEPAGE_URL` .. versionadded:: 3.12 - ``CMAKE_PROJECT_HOMEPAGE_URL`` variable. + The ``CMAKE_PROJECT_HOMEPAGE_URL`` variable. .. note:: diff --git a/Help/cpack_gen/freebsd.rst b/Help/cpack_gen/freebsd.rst index 3cfa4a0c2f..2c9356956c 100644 --- a/Help/cpack_gen/freebsd.rst +++ b/Help/cpack_gen/freebsd.rst @@ -90,7 +90,7 @@ the RPM information (e.g. package license). for Debian packaging, so we may as well re-use it). .. versionadded:: 3.12 - ``CMAKE_PROJECT_HOMEPAGE_URL`` variable. + The ``CMAKE_PROJECT_HOMEPAGE_URL`` variable. .. variable:: CPACK_FREEBSD_PACKAGE_LICENSE diff --git a/Help/cpack_gen/ifw.rst b/Help/cpack_gen/ifw.rst index 0dd2816254..a940a95e75 100644 --- a/Help/cpack_gen/ifw.rst +++ b/Help/cpack_gen/ifw.rst @@ -209,6 +209,8 @@ Package .. variable:: CPACK_IFW_PACKAGE_RESOURCES + .. versionadded:: 3.7 + List of additional resources ('.qrc' files) to include in the installer binary. @@ -279,6 +281,8 @@ These variables are cached, and may be configured if needed. .. variable:: CPACK_IFW_ARCHIVEGEN_EXECUTABLE + .. versionadded:: 3.19 + The path to ``archivegen``. .. variable:: CPACK_IFW_BINARYCREATOR_EXECUTABLE diff --git a/Help/cpack_gen/rpm.rst b/Help/cpack_gen/rpm.rst index a8c3c5cc09..5260a1d7c3 100644 --- a/Help/cpack_gen/rpm.rst +++ b/Help/cpack_gen/rpm.rst @@ -210,7 +210,7 @@ List of CPack RPM generator specific variables: * Default : :variable:`CMAKE_PROJECT_HOMEPAGE_URL` .. versionadded:: 3.12 - ``CMAKE_PROJECT_HOMEPAGE_URL`` variable. + The ``CMAKE_PROJECT_HOMEPAGE_URL`` variable. .. variable:: CPACK_RPM_PACKAGE_DESCRIPTION CPACK_RPM__PACKAGE_DESCRIPTION @@ -527,7 +527,7 @@ List of CPack RPM generator specific variables: rpm -qp --scripts package.rpm .. versionadded:: 3.18 - ``CPACK_RPM_PRE_TRANS_SCRIPT_FILE`` variable. + The ``CPACK_RPM_PRE_TRANS_SCRIPT_FILE`` variable. .. variable:: CPACK_RPM_POST_INSTALL_SCRIPT_FILE CPACK_RPM_POST_UNINSTALL_SCRIPT_FILE @@ -551,7 +551,7 @@ List of CPack RPM generator specific variables: rpm -qp --scripts package.rpm .. versionadded:: 3.18 - ``CPACK_RPM_POST_TRANS_SCRIPT_FILE`` variable. + The ``CPACK_RPM_POST_TRANS_SCRIPT_FILE`` variable. .. variable:: CPACK_RPM_USER_FILELIST CPACK_RPM__USER_FILELIST diff --git a/Help/envvar/CUDAHOSTCXX.rst b/Help/envvar/CUDAHOSTCXX.rst index 19b15e9fc6..963f9d1130 100644 --- a/Help/envvar/CUDAHOSTCXX.rst +++ b/Help/envvar/CUDAHOSTCXX.rst @@ -13,5 +13,8 @@ configuration run (including the first), the environment variable will be ignored if the :variable:`CMAKE_CUDA_HOST_COMPILER` variable is defined. This environment variable is primarily meant for use with projects that -enable ``CUDA`` as a first-class language. The :module:`FindCUDA` -module will also use it to initialize its ``CUDA_HOST_COMPILER`` setting. +enable ``CUDA`` as a first-class language. + +.. versionadded:: 3.13 + The :module:`FindCUDA` + module will use this variable to initialize its ``CUDA_HOST_COMPILER`` setting. diff --git a/Help/generator/Green Hills MULTI.rst b/Help/generator/Green Hills MULTI.rst index c25c5f5d1f..5d2b1cd4dc 100644 --- a/Help/generator/Green Hills MULTI.rst +++ b/Help/generator/Green Hills MULTI.rst @@ -65,7 +65,7 @@ Cache variables that are used for toolset and target system customization: | ``GHS_OS_DIR_OPTION`` default value is ``-os_dir``. .. versionadded:: 3.15 - ``GHS_OS_DIR_OPTION`` variable. + The ``GHS_OS_DIR_OPTION`` variable. * ``GHS_BSP_NAME`` diff --git a/Modules/BundleUtilities.cmake b/Modules/BundleUtilities.cmake index f521d22200..0beff04fdd 100644 --- a/Modules/BundleUtilities.cmake +++ b/Modules/BundleUtilities.cmake @@ -59,9 +59,10 @@ fix each one up according to its own list of prerequisites. Then clear all the keys and call ``verify_app`` on the final bundle to ensure that it is truly standalone. -As an optional parameter (``IGNORE_ITEM``) a list of file names can be passed, -which are then ignored -(e.g. ``IGNORE_ITEM "vcredist_x86.exe;vcredist_x64.exe"``). +.. versionadded:: 3.6 + As an optional parameter (``IGNORE_ITEM``) a list of file names can be passed, + which are then ignored + (e.g. ``IGNORE_ITEM "vcredist_x86.exe;vcredist_x64.exe"``). .. code-block:: cmake @@ -78,9 +79,10 @@ Verifies that an application ```` appears valid based on running analysis tools on it. Calls :command:`message(FATAL_ERROR)` if the application is not verified. -As an optional parameter (``IGNORE_ITEM``) a list of file names can be passed, -which are then ignored -(e.g. ``IGNORE_ITEM "vcredist_x86.exe;vcredist_x64.exe"``) +.. versionadded:: 3.6 + As an optional parameter (``IGNORE_ITEM``) a list of file names can be passed, + which are then ignored + (e.g. ``IGNORE_ITEM "vcredist_x86.exe;vcredist_x64.exe"``) .. code-block:: cmake @@ -155,9 +157,10 @@ them. Set values associated with each key such that we can loop over all of them and copy prerequisite libs into the bundle and then do appropriate ``install_name_tool`` fixups. -As an optional parameter (``IGNORE_ITEM``) a list of file names can be passed, -which are then ignored -(e.g. ``IGNORE_ITEM "vcredist_x86.exe;vcredist_x64.exe"``) +.. versionadded:: 3.6 + As an optional parameter (``IGNORE_ITEM``) a list of file names can be passed, + which are then ignored + (e.g. ``IGNORE_ITEM "vcredist_x86.exe;vcredist_x64.exe"``) .. code-block:: cmake @@ -215,9 +218,10 @@ Verifies that the sum of all prerequisites of all files inside the bundle are contained within the bundle or are ``system`` libraries, presumed to exist everywhere. -As an optional parameter (``IGNORE_ITEM``) a list of file names can be passed, -which are then ignored -(e.g. ``IGNORE_ITEM "vcredist_x86.exe;vcredist_x64.exe"``) +.. versionadded:: 3.6 + As an optional parameter (``IGNORE_ITEM``) a list of file names can be passed, + which are then ignored + (e.g. ``IGNORE_ITEM "vcredist_x86.exe;vcredist_x64.exe"``) .. code-block:: cmake diff --git a/Modules/CMakeGraphVizOptions.cmake b/Modules/CMakeGraphVizOptions.cmake index be4a3be365..708672258a 100644 --- a/Modules/CMakeGraphVizOptions.cmake +++ b/Modules/CMakeGraphVizOptions.cmake @@ -29,8 +29,9 @@ Graphviz package: dot -Tpng -o foo.png foo.dot -The different dependency types ``PUBLIC``, ``INTERFACE`` and ``PRIVATE`` -are represented as solid, dashed and dotted edges. +.. versionadded:: 3.10 + The different dependency types ``PUBLIC``, ``INTERFACE`` and ``PRIVATE`` + are represented as solid, dashed and dotted edges. Variables specific to the Graphviz support ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/Modules/CMakePackageConfigHelpers.cmake b/Modules/CMakePackageConfigHelpers.cmake index 1a7f9cf2b1..372e9f4632 100644 --- a/Modules/CMakePackageConfigHelpers.cmake +++ b/Modules/CMakePackageConfigHelpers.cmake @@ -81,13 +81,14 @@ always relative to the installed location of the package. This works both for relative and also for absolute locations. For absolute locations it works only if the absolute location is a subdirectory of ``INSTALL_PREFIX``. -If the ``INSTALL_PREFIX`` argument is passed, this is used as base path to -calculate all the relative paths. The ```` argument must be an absolute -path. If this argument is not passed, the :variable:`CMAKE_INSTALL_PREFIX` -variable will be used instead. The default value is good when generating a -FooConfig.cmake file to use your package from the install tree. When -generating a FooConfig.cmake file to use your package from the build tree this -option should be used. +.. versionadded:: 3.1 + If the ``INSTALL_PREFIX`` argument is passed, this is used as base path to + calculate all the relative paths. The ```` argument must be an absolute + path. If this argument is not passed, the :variable:`CMAKE_INSTALL_PREFIX` + variable will be used instead. The default value is good when generating a + FooConfig.cmake file to use your package from the install tree. When + generating a FooConfig.cmake file to use your package from the build tree this + option should be used. By default ``configure_package_config_file`` also generates two helper macros, ``set_and_check()`` and ``check_required_components()`` into the @@ -159,23 +160,28 @@ If your project has more elaborated version matching rules, you will need to write your own custom ``ConfigVersion.cmake`` file instead of using this macro. -.. note:: ``COMPATIBILITY_MODE`` ``AnyNewerVersion`` handles the version range +.. versionadded:: 3.11 + The ``SameMinorVersion`` compatibility mode. + +.. versionadded:: 3.14 + If ``ARCH_INDEPENDENT`` is given, the installed package version will be + considered compatible even if it was built for a different architecture than + the requested architecture. Otherwise, an architecture check will be performed, + and the package will be considered compatible only if the architecture matches + exactly. For example, if the package is built for a 32-bit architecture, the + package is only considered compatible if it is used on a 32-bit architecture, + unless ``ARCH_INDEPENDENT`` is given, in which case the package is considered + compatible on any architecture. + +.. note:: ``ARCH_INDEPENDENT`` is intended for header-only libraries or similar + packages with no binaries. + +.. versionadded:: 3.19 + ``COMPATIBILITY_MODE`` ``AnyNewerVersion`` handles the version range if any is specified (see :command:`find_package` command for the details). All other modes are incompatible with version ranges and will display an author warning if one is specified. -If ``ARCH_INDEPENDENT`` is given, the installed package version will be -considered compatible even if it was built for a different architecture than -the requested architecture. Otherwise, an architecture check will be performed, -and the package will be considered compatible only if the architecture matches -exactly. For example, if the package is built for a 32-bit architecture, the -package is only considered compatible if it is used on a 32-bit architecture, -unless ``ARCH_INDEPENDENT`` is given, in which case the package is considered -compatible on any architecture. - -.. note:: ``ARCH_INDEPENDENT`` is intended for header-only libraries or similar - packages with no binaries. - Internally, this macro executes :command:`configure_file()` to create the resulting version file. Depending on the ``COMPATIBILITY``, the corresponding ``BasicConfigVersion-.cmake.in`` file is used. diff --git a/Modules/CPack.cmake b/Modules/CPack.cmake index 7529a1f431..eb1d43b515 100644 --- a/Modules/CPack.cmake +++ b/Modules/CPack.cmake @@ -194,6 +194,8 @@ installers. The most commonly-used variables are: .. variable:: CPACK_PACKAGE_CHECKSUM + .. versionadded:: 3.7 + An algorithm that will be used to generate an additional file with the checksum of the package. The output file name will be:: @@ -271,6 +273,8 @@ installers. The most commonly-used variables are: .. variable:: CPACK_VERBATIM_VARIABLES + .. versionadded:: 3.4 + If set to ``TRUE``, values of variables prefixed with ``CPACK_`` will be escaped before being written to the configuration files, so that the cpack program receives them exactly as they were specified. If not, characters @@ -356,6 +360,8 @@ The following variables are for advanced uses of CPack: .. variable:: CPACK_INSTALL_SCRIPTS + .. versionadded:: 3.16 + Extra CMake scripts executed by CPack during its local staging installation. They are executed before installing the files to be packaged. The scripts are not called by a standalone install (e.g.: ``make install``). @@ -372,6 +378,8 @@ The following variables are for advanced uses of CPack: .. variable:: CPACK_PRE_BUILD_SCRIPTS + .. versionadded:: 3.19 + List of CMake scripts to execute after CPack has installed the files to be packaged into a staging directory and before producing the package(s) from those files. See also :variable:`CPACK_INSTALL_SCRIPTS` and @@ -379,6 +387,8 @@ The following variables are for advanced uses of CPack: .. variable:: CPACK_POST_BUILD_SCRIPTS + .. versionadded:: 3.19 + List of CMake scripts to execute after CPack has produced the resultant packages and before copying them back to the build directory. See also :variable:`CPACK_INSTALL_SCRIPTS`, @@ -386,6 +396,8 @@ The following variables are for advanced uses of CPack: .. variable:: CPACK_PACKAGE_FILES + .. versionadded:: 3.19 + List of package files created in the staging directory, with each file provided as a full absolute path. This variable is populated by CPack just before invoking the post-build scripts listed in diff --git a/Modules/CPackIFW.cmake b/Modules/CPackIFW.cmake index 6ce0bfcc8a..d57cf18bac 100644 --- a/Modules/CPackIFW.cmake +++ b/Modules/CPackIFW.cmake @@ -51,20 +51,28 @@ The module defines the following commands: of a group to which it belongs. ``ESSENTIAL`` + .. versionadded:: 3.6 + if set, then the package manager stays disabled until that component is updated. ``VIRTUAL`` + .. versionadded:: 3.8 + if set, then the component will be hidden from the installer. It is a equivalent of the ``HIDDEN`` option from the :command:`cpack_add_component` command. ``FORCED_INSTALLATION`` + .. versionadded:: 3.8 + if set, then the component must always be installed. It is a equivalent of the ``REQUIRED`` option from the :command:`cpack_add_component` command. ``REQUIRES_ADMIN_RIGHTS`` + .. versionadded:: 3.8 + set it if the component needs to be installed with elevated permissions. ``NAME`` @@ -72,14 +80,20 @@ The module defines the following commands: By default used origin component name. ``DISPLAY_NAME`` + .. versionadded:: 3.8 + set to rewrite original name configured by :command:`cpack_add_component` command. ``DESCRIPTION`` + .. versionadded:: 3.8 + set to rewrite original description configured by :command:`cpack_add_component` command. ``UPDATE_TEXT`` + .. versionadded:: 3.8 + will be added to the component description if this is an update to the component. @@ -88,22 +102,32 @@ The module defines the following commands: By default used :variable:`CPACK_PACKAGE_VERSION`. ``RELEASE_DATE`` + .. versionadded:: 3.8 + keep empty to auto generate. ``SCRIPT`` is a relative or absolute path to operations script for this component. - ``PRIORITY`` | ``SORTING_PRIORITY`` - is priority of the component in the tree. - The ``PRIORITY`` option is deprecated and will be removed in a future - version of CMake. Please use ``SORTING_PRIORITY`` option instead. + ``SORTING_PRIORITY`` + .. versionadded:: 3.8 + + is priority of the component in the tree. + + ``PRIORITY`` + .. deprecated:: 3.8 + Old name for ``SORTING_PRIORITY``. + + ``DEPENDS``, ``DEPENDENCIES`` + .. versionadded:: 3.8 - ``DEPENDS`` | ``DEPENDENCIES`` list of dependency component or component group identifiers in QtIFW style. ``AUTO_DEPEND_ON`` + .. versionadded:: 3.8 + list of identifiers of component or component group in QtIFW style that this component has an automatic dependency on. @@ -112,21 +136,31 @@ The module defines the following commands: component. You can specify more then one license. ``DEFAULT`` + .. versionadded:: 3.8 + Possible values are: TRUE, FALSE, and SCRIPT. Set to FALSE to disable the component in the installer or to SCRIPT to resolved during runtime (don't forget add the file of the script as a value of the ``SCRIPT`` option). ``USER_INTERFACES`` + .. versionadded:: 3.7 + is a list of ('.ui' files) representing pages to load. ``TRANSLATIONS`` + .. versionadded:: 3.8 + is a list of ('.qm' files) representing translations to load. ``REPLACES`` + .. versionadded:: 3.10 + list of identifiers of component or component group to replace. ``CHECKABLE`` + .. versionadded:: 3.10 + Possible values are: TRUE, FALSE. Set to FALSE if you want to hide the checkbox for an item. This is useful when only a few subcomponents should be selected @@ -162,13 +196,19 @@ The module defines the following commands: command. ``VIRTUAL`` + .. versionadded:: 3.8 + if set, then the group will be hidden from the installer. Note that setting this on a root component does not work. ``FORCED_INSTALLATION`` + .. versionadded:: 3.8 + if set, then the group must always be installed. ``REQUIRES_ADMIN_RIGHTS`` + .. versionadded:: 3.8 + set it if the component group needs to be installed with elevated permissions. @@ -177,14 +217,20 @@ The module defines the following commands: By default used origin component group name. ``DISPLAY_NAME`` + .. versionadded:: 3.8 + set to rewrite original name configured by :command:`cpack_add_component_group` command. ``DESCRIPTION`` + .. versionadded:: 3.8 + set to rewrite original description configured by :command:`cpack_add_component_group` command. ``UPDATE_TEXT`` + .. versionadded:: 3.8 + will be added to the component group description if this is an update to the component group. @@ -193,22 +239,30 @@ The module defines the following commands: By default used :variable:`CPACK_PACKAGE_VERSION`. ``RELEASE_DATE`` + .. versionadded:: 3.8 + keep empty to auto generate. ``SCRIPT`` is a relative or absolute path to operations script for this component group. - ``PRIORITY`` | ``SORTING_PRIORITY`` + ``SORTING_PRIORITY`` is priority of the component group in the tree. - The ``PRIORITY`` option is deprecated and will be removed in a future - version of CMake. Please use ``SORTING_PRIORITY`` option instead. - ``DEPENDS`` | ``DEPENDENCIES`` + ``PRIORITY`` + .. deprecated:: 3.8 + Old name for ``SORTING_PRIORITY``. + + ``DEPENDS``, ``DEPENDENCIES`` + .. versionadded:: 3.8 + list of dependency component or component group identifiers in QtIFW style. ``AUTO_DEPEND_ON`` + .. versionadded:: 3.8 + list of identifiers of component or component group in QtIFW style that this component group has an automatic dependency on. @@ -217,6 +271,8 @@ The module defines the following commands: component group. You can specify more then one license. ``DEFAULT`` + .. versionadded:: 3.8 + Possible values are: TRUE, FALSE, and SCRIPT. Set to TRUE to preselect the group in the installer (this takes effect only on groups that have no visible child components) @@ -224,15 +280,23 @@ The module defines the following commands: the script as a value of the ``SCRIPT`` option). ``USER_INTERFACES`` + .. versionadded:: 3.7 + is a list of ('.ui' files) representing pages to load. ``TRANSLATIONS`` + .. versionadded:: 3.8 + is a list of ('.qm' files) representing translations to load. ``REPLACES`` + .. versionadded:: 3.10 + list of identifiers of component or component group to replace. ``CHECKABLE`` + .. versionadded:: 3.10 + Possible values are: TRUE, FALSE. Set to FALSE if you want to hide the checkbox for an item. This is useful when only a few subcomponents should be selected @@ -272,6 +336,8 @@ The module defines the following commands: .. command:: cpack_ifw_update_repository + .. versionadded:: 3.6 + Update QtIFW specific repository from remote repository. :: @@ -307,6 +373,8 @@ The module defines the following commands: .. command:: cpack_ifw_add_package_resources + .. versionadded:: 3.7 + Add additional resources in the installer binary. :: diff --git a/Modules/CTestCoverageCollectGCOV.cmake b/Modules/CTestCoverageCollectGCOV.cmake index a01a2fea22..a6fa3a4c6c 100644 --- a/Modules/CTestCoverageCollectGCOV.cmake +++ b/Modules/CTestCoverageCollectGCOV.cmake @@ -39,7 +39,10 @@ After generating this tar file, it can be sent to CDash for display with the upload to CDash. Relative paths will be interpreted with respect to the top-level build directory. - ``TARBALL_COMPRESSION