summaryrefslogtreecommitdiffstats
path: root/Help
diff options
context:
space:
mode:
authorJoachim Wuttke (o) <j.wuttke@fz-juelich.de>2020-02-17 11:03:59 (GMT)
committerBrad King <brad.king@kitware.com>2020-02-17 16:14:52 (GMT)
commitb3f4d5034840f1fb29c341a4f71256970af6b906 (patch)
tree0696d9213b551ba3accdbb9e5cd7d6c966a9d203 /Help
parentc671966c200e50da0119875288a2a63486be97ab (diff)
downloadCMake-b3f4d5034840f1fb29c341a4f71256970af6b906.zip
CMake-b3f4d5034840f1fb29c341a4f71256970af6b906.tar.gz
CMake-b3f4d5034840f1fb29c341a4f71256970af6b906.tar.bz2
Help: ifw.rst: Add toc; mv "Hints" section -> subsection of "Variables"
Also explain `@ApplicationsDir@`, thanks to https://discourse.cmake.org/t/647/2 for help.
Diffstat (limited to 'Help')
-rw-r--r--Help/cpack_gen/ifw.rst58
1 files changed, 32 insertions, 26 deletions
diff --git a/Help/cpack_gen/ifw.rst b/Help/cpack_gen/ifw.rst
index 1d1a55b..d7c71b4 100644
--- a/Help/cpack_gen/ifw.rst
+++ b/Help/cpack_gen/ifw.rst
@@ -3,6 +3,10 @@ CPack IFW Generator
Configure and run the Qt Installer Framework to generate a Qt installer.
+.. only:: html
+
+ .. contents::
+
Overview
^^^^^^^^
@@ -20,32 +24,6 @@ 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
-^^^^^
-
-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.
-
- 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
- suite.
-
-.. note::
- The specified path should not contain "bin" at the end
- (for example: "D:\\DevTools\\QtIFW2.0.5").
-
-The :variable:`CPACK_IFW_ROOT` variable has a higher priority and overrides
-the value of the :variable:`QTIFWDIR` variable.
-
Internationalization
^^^^^^^^^^^^^^^^^^^^
@@ -161,6 +139,8 @@ Package
Default target directory for installation.
By default used
"@ApplicationsDir@/:variable:`CPACK_PACKAGE_INSTALL_DIRECTORY`"
+ (variables embedded in '@' are expanded by the
+ `QtIFW scripting engine <https://doc.qt.io/qtinstallerframework/scripting.html>`_).
You can use predefined variables.
@@ -294,6 +274,32 @@ These variables are cached, and may be configured if needed.
The path to ``devtool``.
+Hints for Finding QtIFW
+"""""""""""""""""""""""
+
+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.
+
+ 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
+ suite.
+
+.. note::
+ The specified path should not contain "bin" at the end
+ (for example: "D:\\DevTools\\QtIFW2.0.5").
+
+The :variable:`CPACK_IFW_ROOT` variable has a higher priority and overrides
+the value of the :variable:`QTIFWDIR` variable.
+
Online installer
^^^^^^^^^^^^^^^^