Add documentation on windeployqt.

Task-number: QTBUG-28766
Change-Id: I677f4056e76564fc1a497544ba46c04027ff040b
Reviewed-by: Oliver Wolff <oliver.wolff@digia.com>
Reviewed-by: Andrew Knight <andrew.knight@digia.com>
Reviewed-by: Joerg Bornemann <joerg.bornemann@digia.com>
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>

2 files changed, 63 insertions, 1 deletions

diff --git a/doc/src/platforms/windows.qdoc b/doc/src/platforms/windows.qdoc
index 744956bb..edef05c8 100644
--- a/doc/src/platforms/windows.qdoc
+++ b/doc/src/platforms/windows.qdoc
@@ -747,6 +747,68 @@
     need to pay attention to when building and deploying plugins for
     Qt applications.
 
+    \section1 The Windows Deployment Tool
+    \target windeployqt
+    The Windows deployment tool can be found in QTDIR/bin/windeployqt. It is
+    designed to automate the process of creating a deployable folder that contains
+    all libraries, QML imports, plugins, translations that are required to run the application
+    from that folder. This is used to create the sandbox for \l{Qt for WinRT}{Windows Runtime}
+    or an installation tree for Windows desktop applications that can be easily bundled by an installer.
+
+    \badcode
+Usage: windeployqt [options] [file]
+Qt Deploy Tool 5.3.0
+
+The simplest way to use windeployqt is to add the bin directory of your Qt
+installation (e.g. <QT_DIR\bin>) to the PATH variable and then run:
+  windeployqt <path-to-app-binary>
+If ICU, ANGLE, etc. are not in the bin directory, they need to be in the PATH
+variable. If your application uses Qt Quick, run:
+  windeployqt --qmldir <path-to-app-qml-files> <path-to-app-binary>
+
+Options:
+  -?, -h, --help            Displays this help.
+  -v, --version             Displays version information.
+  --dir <directory>         Use directory instead of binary directory.
+  --libdir <path>           Copy libraries to path.
+  --debug                   Assume debug binaries.
+  --release                 Assume release binaries.
+  --force                   Force updating files.
+  --dry-run                 Simulation mode. Behave normally, but do not
+                            copy/update any files.
+  --no-plugins              Skip plugin deployment.
+  --no-libraries            Skip library deployment.
+  --qmldir <directory>      Scan for QML-imports starting from directory.
+  --no-quick-import         Skip deployment of Qt Quick imports.
+  --no-translations         Skip deployment of translations.
+  --no-system-d3d-compiler  Skip deployment of the system D3D compiler.
+  --compiler-runtime        Deploy compiler runtime (Desktop only).
+  --no-compiler-runtime     Do not deploy compiler runtime (Desktop only).
+  --webkit2                 Deployment of WebKit2 (web process).
+  --no-webkit2              Skip deployment of WebKit2.
+  --json                    Print to stdout in JSON format.
+  --list <option>           Print only the names of the files copied.
+                            Available options:
+                             source:   absolute path of the source files
+                             target:   absolute path of the target files
+                             relative: paths of the target files, relative
+                                       to the target directory
+                             mapping:  outputs the source and the relative
+                                       target, suitable for use within an
+                                       Appx mapping file
+  --verbose <level>         Verbose level.
+
+Qt libraries can be added by passing their name (-xml) or removed by passing
+the name prepended by --no- (--no-xml). Available libraries:
+bluetooth clucene concurrent core declarative designercomponents designer gui
+clucene qthelp multimedia multimediawidgets multimediaquick network nfc opengl
+positioning printsupport qml quick quickparticles script scripttools sensors
+serialport sql svg test widgets winextras xml xmlpatterns
+
+Arguments:
+  [file]                    Binary or directory containing the binary.
+\endcode
+
 */
 
 /*!
diff --git a/doc/src/platforms/winrt.qdoc b/doc/src/platforms/winrt.qdoc
index 00c3b4bf..e8317de9 100644
--- a/doc/src/platforms/winrt.qdoc
+++ b/doc/src/platforms/winrt.qdoc
@@ -97,7 +97,7 @@
     This creates a project which supports building applications and running them
     with Visual Studio. It does not embed Qt libraries into the package and
     requires you to add them manually. For this purpose, the command line
-    tool \c windeployqt has been included in the installed package. To
+    tool \l{The Windows Deployment Tool}{windeployqt} has been included in the installed package. To
     enable automatic parsing of dependencies and adding the libraries and
     dependencies into the application package, create the project with the
     following options: