From 4a6924782e30dee151ac483c1356aca901b04537 Mon Sep 17 00:00:00 2001
From: Friedemann Kleint <Friedemann.Kleint@qt.io>
Date: Wed, 19 Oct 2016 14:10:03 +0200
Subject: [PATCH] Improve windeployqt documentation
Make it a clearer that the tool is intended for the Qt-related
dependencies and mention compiler runtime.
Task-number: QTBUG-56566
Change-Id: Idfa938943c486fc5632510bfe9eba119cbcfc58e
Reviewed-by: Oliver Wolff <oliver.wolff@qt.io>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Maurice Kalinowski <maurice.kalinowski@qt.io>
---
doc/src/platforms/windows.qdoc | 17 ++++++++++++++---
1 file changed, 14 insertions(+), 3 deletions(-)
diff --git a/doc/src/platforms/windows.qdoc b/doc/src/platforms/windows.qdoc
index eb66edf7..4e367790 100644
--- a/doc/src/platforms/windows.qdoc
+++ b/doc/src/platforms/windows.qdoc
@@ -527,9 +527,10 @@
\section1 The Windows Deployment Tool
\target windeployqt
The Windows deployment tool is designed to automate the process of creating
- a deployable folder containing the dependencies (libraries, QML imports,
- plugins, and translations) that are required to run the application from
- that folder. It creates a sandbox for \l{Qt for WinRT}{Windows Runtime}
+ a deployable folder containing the \l{Qt}-related dependencies
+ (libraries, QML imports, plugins, and translations) required to run
+ the application from that folder.
+ It creates a sandbox for \l{Qt for WinRT}{Windows Runtime}
or an installation tree for Windows desktop applications, which can be
easily bundled into an installation package.
@@ -542,6 +543,16 @@
directory. The hardcoded local paths in Qt5Core.dll are furthermore replaced
with relative ones.
+ For Windows desktop applications, the required runtime files for the compiler
+ are also copied to the deployable folder by default (unless the option
+ \c --no-compiler-runtime is specified). In the case of release builds using
+ Microsoft Visual C++, these consist of the Visual C++ Redistributable Packages,
+ which are intended for recursive installation by the application's installer on
+ the target machine. Otherwise, the shared libraries of the compiler runtime are used.
+
+ The application may require additional 3rd-party libraries (for example,
+ database libraries), which are not taken into account by windeployqt.
+
Additional arguments are described in the tools' help output:
\badcode
--
GitLab