reactos/CMake
1
0
Fork 0
mirror of https://github.com/reactos/CMake.git synced 2025-02-07 20:38:49 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge topic 'cpack-ifw-qt-links'

Browse Source 
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
This commit is contained in:
Brad King 2020-02-12 14:35:16 +00:00 committed by Kitware Robot
commit 495f4c717c
2 changed files with 30 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
Help/cpack_gen/ifw.rst
View File

@ -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.
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).
CPack IFW generator prepares project installation and generates configuration
and meta information for QtIFW_ tools.
QtIFW provides tools and utilities to create installers for
the platforms supported by `Qt <https://www.qt.io>`_: Linux,
Microsoft Windows, and macOS.
The QtIFW_ provides a set of tools and utilities to create
installers for the supported desktop Qt platforms: 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

23
Modules/CPackIFW.cmake
View File

@ -5,15 +5,12 @@
CPackIFW
--------
The documentation for the CPack IFW generator has moved here: :cpack_gen:`CPack IFW Generator`
.. _QtIFW: http://doc.qt.io/qtinstallerframework/index.html
This module looks for the location of the command line utilities supplied
with the Qt Installer Framework (QtIFW_).
This module looks for the location of the command-line utilities supplied with the
`Qt Installer Framework <http://doc.qt.io/qtinstallerframework/index.html>`_
(QtIFW).
The module also defines several commands to control the behavior of the
CPack ``IFW`` generator.
:cpack_gen:`CPack IFW Generator`.
Commands
^^^^^^^^
@ -102,10 +99,10 @@ The module defines the following commands:
``DEPENDS`` | ``DEPENDENCIES``
list of dependency component or component group identifiers in
QtIFW_ style.
QtIFW style.
``AUTO_DEPEND_ON``
list of identifiers of component or component group in QtIFW_ style
list of identifiers of component or component group in QtIFW style
that this component has an automatic dependency on.
``LICENSES``
@ -207,10 +204,10 @@ The module defines the following commands:
``DEPENDS`` | ``DEPENDENCIES``
list of dependency component or component group identifiers in
QtIFW_ style.
QtIFW style.
``AUTO_DEPEND_ON``
list of identifiers of component or component group in QtIFW_ style
list of identifiers of component or component group in QtIFW style
that this component group has an automatic dependency on.
``LICENSES``
@ -242,7 +239,7 @@ The module defines the following commands:
.. command:: cpack_ifw_add_repository
Add QtIFW_ specific remote repository to binary installer.
Add QtIFW specific remote repository to binary installer.
::
@ -273,7 +270,7 @@ The module defines the following commands:
.. command:: cpack_ifw_update_repository
Update QtIFW_ specific repository from remote repository.
Update QtIFW specific repository from remote repository.
::