summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2020-02-14 13:39:46 (GMT)
committerKitware Robot <kwrobot@kitware.com>2020-02-14 13:40:36 (GMT)
commit5ec88546dd363d82d877646eea86e198aef7b033 (patch)
treeddba377f0ce679836e6496714538d6ad8912267a
parentadd917754f98575b17c71f3defec98a763cf7565 (diff)
parentfdf50941d27c3efd088dbbe8986f816cdade5d3f (diff)
downloadCMake-5ec88546dd363d82d877646eea86e198aef7b033.zip
CMake-5ec88546dd363d82d877646eea86e198aef7b033.tar.gz
CMake-5ec88546dd363d82d877646eea86e198aef7b033.tar.bz2
Merge topic 'cpack-doc-ifw'
fdf50941d2 Help: CPack IFW Generator: not only configures, but also runs QtIFW. 6bb248c133 Help: More cross references between CPackIFW and CPackIFWGenerator. Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !4356
-rw-r--r--Help/cpack_gen/ifw.rst36
1 files changed, 18 insertions, 18 deletions
diff --git a/Help/cpack_gen/ifw.rst b/Help/cpack_gen/ifw.rst
index 4a9ab99..b1e4ee0 100644
--- a/Help/cpack_gen/ifw.rst
+++ b/Help/cpack_gen/ifw.rst
@@ -1,20 +1,24 @@
CPack IFW Generator
-------------------
+Configure and run the Qt Installer Framework to generate a Qt installer.
+
Overview
^^^^^^^^
This :manual:`cpack generator <cpack-generators(7)>` generates
configuration and meta information for the `Qt Installer Framework
-<http://doc.qt.io/qtinstallerframework/index.html>`_ (QtIFW).
+<http://doc.qt.io/qtinstallerframework/index.html>`_ (QtIFW),
+and runs QtIFW tools to generate a Qt installer.
QtIFW provides tools and utilities to create installers for
the platforms supported by `Qt <https://www.qt.io>`_: Linux,
Microsoft Windows, and macOS.
-To make use of this generator, QtIFW should also be installed.
-The module :module:`CPackIFW` looks for the location of the
-QtIFW command-line utilities.
+To make use of this generator, QtIFW needs to be installed.
+The :module:`CPackIFW` module looks for the location of the
+QtIFW command-line utilities, and defines several commands to
+control the behavior of this generator.
Hints
^^^^^
@@ -263,36 +267,32 @@ Components
repack dependent components. This feature available only
since QtIFW 3.1.
-Tools
-"""""
+QtIFW Tools
+"""""""""""
.. variable:: CPACK_IFW_FRAMEWORK_VERSION
The version of used QtIFW tools.
-.. variable:: CPACK_IFW_BINARYCREATOR_EXECUTABLE
+The following variables provide the locations of the QtIFW
+command-line tools as discovered by the module :module:`CPackIFW`.
+These variables are cached, and may be configured if needed.
- The path to "binarycreator" command line client.
+.. variable:: CPACK_IFW_BINARYCREATOR_EXECUTABLE
- This variable is cached and may be configured if needed.
+ The path to ``binarycreator``.
.. variable:: CPACK_IFW_REPOGEN_EXECUTABLE
- The path to "repogen" command line client.
-
- This variable is cached and may be configured if needed.
+ The path to ``repogen``.
.. variable:: CPACK_IFW_INSTALLERBASE_EXECUTABLE
- The path to "installerbase" installer executable base.
-
- This variable is cached and may be configured if needed.
+ The path to ``installerbase``.
.. variable:: CPACK_IFW_DEVTOOL_EXECUTABLE
- The path to "devtool" command line client.
-
- This variable is cached and may be configured if needed.
+ The path to ``devtool``.
Online installer