summaryrefslogtreecommitdiffstats
path: root/Help
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2020-02-12 14:35:16 (GMT)
committerKitware Robot <kwrobot@kitware.com>2020-02-12 14:35:22 (GMT)
commit495f4c717c93d4999220849b877827ea5d063a66 (patch)
treebd0531c7e83c5ed5bb16c9eee7e2578a89b631fe /Help
parent506ffedf6ccb518f48822f4e960c67f3e14cf4f8 (diff)
parente240371ab1e8a104bf13277ff18a61defd7902cb (diff)
downloadCMake-495f4c717c93d4999220849b877827ea5d063a66.zip
CMake-495f4c717c93d4999220849b877827ea5d063a66.tar.gz
CMake-495f4c717c93d4999220849b877827ea5d063a66.tar.bz2
Merge topic 'cpack-ifw-qt-links'
e240371ab1 Help: CPackIFWGenerator: explain relation to CPackIWF 78779c6111 Help: Show external link only once per page; explain abbreviation QtIFW. Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !4348
Diffstat (limited to 'Help')
-rw-r--r--Help/cpack_gen/ifw.rst45
1 files changed, 20 insertions, 25 deletions
diff --git a/Help/cpack_gen/ifw.rst b/Help/cpack_gen/ifw.rst
index feccd3d..4a9ab99 100644
--- a/Help/cpack_gen/ifw.rst
+++ b/Help/cpack_gen/ifw.rst
@@ -1,43 +1,38 @@
CPack IFW Generator
-------------------
-See :module:`CPackIFW` for details on the CPackIFW module.
-
-.. _QtIFW: http://doc.qt.io/qtinstallerframework/index.html
-
-
Overview
^^^^^^^^
-CPack ``IFW`` generator helps you to create online and offline
-binary cross-platform installers with a graphical user interface.
-
-CPack IFW generator prepares project installation and generates configuration
-and meta information for QtIFW_ tools.
+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).
-The QtIFW_ provides a set of tools and utilities to create
-installers for the supported desktop Qt platforms: Linux, Microsoft Windows,
-and macOS.
+QtIFW provides tools and utilities to create installers for
+the platforms supported by `Qt <https://www.qt.io>`_: Linux,
+Microsoft Windows, and macOS.
-You should also install QtIFW_ to use CPack ``IFW`` generator.
+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.
Hints
^^^^^
-Generally, the CPack ``IFW`` generator automatically finds QtIFW_ tools,
-but if you don't use a default path for installation of the QtIFW_ tools,
+Generally, the CPack ``IFW`` generator automatically finds QtIFW tools,
+but if you don't use a default path for installation of the QtIFW tools,
the path may be specified in either a CMake or an environment variable:
.. variable:: CPACK_IFW_ROOT
- An CMake variable which specifies the location of the QtIFW_ tool suite.
+ An CMake variable which specifies the location of the QtIFW tool suite.
The variable will be cached in the ``CPackConfig.cmake`` file and used at
CPack runtime.
.. variable:: QTIFWDIR
- An environment variable which specifies the location of the QtIFW_ tool
+ An environment variable which specifies the location of the QtIFW tool
suite.
.. note::
@@ -53,7 +48,7 @@ Internationalization
Some variables and command arguments support internationalization via
CMake script. This is an optional feature.
-Installers created by QtIFW_ tools have built-in support for
+Installers created by QtIFW tools have built-in support for
internationalization and many phrases are localized to many languages,
but this does not apply to the description of the your components and groups
that will be distributed.
@@ -185,7 +180,7 @@ Package
Filename of the generated maintenance tool.
The platform-specific executable file extension is appended.
- By default used QtIFW_ defaults (``maintenancetool``).
+ By default used QtIFW defaults (``maintenancetool``).
.. variable:: CPACK_IFW_PACKAGE_REMOVE_TARGET_DIR
@@ -197,19 +192,19 @@ Package
Filename for the configuration of the generated maintenance tool.
- By default used QtIFW_ defaults (``maintenancetool.ini``).
+ By default used QtIFW defaults (``maintenancetool.ini``).
.. variable:: CPACK_IFW_PACKAGE_ALLOW_NON_ASCII_CHARACTERS
Set to ``ON`` if the installation path can contain non-ASCII characters.
- Is ``ON`` for QtIFW_ less 2.0 tools.
+ Is ``ON`` for QtIFW less 2.0 tools.
.. variable:: CPACK_IFW_PACKAGE_ALLOW_SPACE_IN_PATH
Set to ``OFF`` if the installation path cannot contain space characters.
- Is ``ON`` for QtIFW_ less 2.0 tools.
+ Is ``ON`` for QtIFW less 2.0 tools.
.. variable:: CPACK_IFW_PACKAGE_CONTROL_SCRIPT
@@ -266,14 +261,14 @@ Components
Additional prepared repository dirs that will be used to resolve and
repack dependent components. This feature available only
- since QtIFW_ 3.1.
+ since QtIFW 3.1.
Tools
"""""
.. variable:: CPACK_IFW_FRAMEWORK_VERSION
- The version of used QtIFW_ tools.
+ The version of used QtIFW tools.
.. variable:: CPACK_IFW_BINARYCREATOR_EXECUTABLE