summaryrefslogtreecommitdiffstats
path: root/Modules/CPackIFW.cmake
diff options
context:
space:
mode:
authorNikita Nemkin <nikita@nemkin.ru>2020-11-12 08:40:33 (GMT)
committerNikita Nemkin <nikita@nemkin.ru>2020-12-02 16:00:30 (GMT)
commit8fea95319bcaac741faf93bd66b3a1838b56a418 (patch)
tree2bc107ce0cc4844e79f0baf93a394d93c27edaa8 /Modules/CPackIFW.cmake
parent8634561dcae9f5ff5128eaf7c83aa71170992ec2 (diff)
downloadCMake-8fea95319bcaac741faf93bd66b3a1838b56a418.zip
CMake-8fea95319bcaac741faf93bd66b3a1838b56a418.tar.gz
CMake-8fea95319bcaac741faf93bd66b3a1838b56a418.tar.bz2
Help: Add `.. versionadded` directives to module docs
Issue: #19715
Diffstat (limited to 'Modules/CPackIFW.cmake')
-rw-r--r--Modules/CPackIFW.cmake84
1 files changed, 76 insertions, 8 deletions
diff --git a/Modules/CPackIFW.cmake b/Modules/CPackIFW.cmake
index 6ce0bfc..d57cf18 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``
+ ``SORTING_PRIORITY``
+ .. versionadded:: 3.8
+
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.
- ``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 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 <file_path> ('.ui' files) representing pages to load.
``TRANSLATIONS``
+ .. versionadded:: 3.8
+
is a list of <file_path> ('.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 <file_path> ('.ui' files) representing pages to load.
``TRANSLATIONS``
+ .. versionadded:: 3.8
+
is a list of <file_path> ('.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.
::