Add Documentation on how to add Automation to Boot2Qt5.12

Task-number: QTBUG-72001
Task-number: QTBUG-71956
Change-Id: Ife8f046f734fb1d598e8df6f2fb785ef0bf4e7f6
Sanity-Review: Qt Sanity Bot <qt_sanitybot@qt-project.org>
Reviewed-by: Maurice Kalinowski <maurice.kalinowski@qt.io>

5 files changed, 61 insertions, 12 deletions

diff --git a/images/qtmqtt-build-settings.png b/images/qtmqtt-build-settings.png
new file mode 100644
index 0000000..fecdea4
--- /dev/null
+++ b/images/qtmqtt-build-settings.png
diff --git a/src/external-resources.qdoc b/src/external-resources.qdoc
index 0f5f51c..840ae47 100644
--- a/src/external-resources.qdoc
+++ b/src/external-resources.qdoc
@@ -1,6 +1,6 @@
 /****************************************************************************
 **
-** Copyright (C) 2018 The Qt Company Ltd.
+** Copyright (C) 2019 The Qt Company Ltd.
 ** Contact: https://www.qt.io/licensing/
 **
 ** This file is part of the documentation of Qt for Automation.
@@ -58,6 +58,16 @@
 */
 
 /*!
+    \externalpage https://doc.qt.io/qtcreator/creator-project-opening.html
+    \title Qt Creator: Opening Projects
+*/
+
+/*!
+    \externalpage https://doc.qt.io/qtcreator/creator-building-targets.html
+    \title Qt Creator: Building for Multiple Platform
+*/
+
+/*!
     \externalpage https://doc.qt.io/QtForDeviceCreation/index.html
     \title Qt for Device Creation
 */
diff --git a/src/qtforautomation-project.qdocconf b/src/qtforautomation-project.qdocconf
index 03d6ffa..41b2a6a 100644
--- a/src/qtforautomation-project.qdocconf
+++ b/src/qtforautomation-project.qdocconf
@@ -4,6 +4,7 @@ version                       = $QT_VERSION
 url                           = https://doc.qt.io/QtForAutomation
 
 sourcedirs                   += .
+imagedirs = ../images
 
 qhp.projects                  = QtForAutomation
 
@@ -28,7 +29,7 @@ tagfile                       = qtforautomation.tags
 depends += qtmqtt qtknx qtopcua
 
 # dependencies to Qt docs
-depends += qtdoc qtquickcontrols2 qtwebengine qtvirtualkeyboard qtquick qtserialbus
+depends += qtdoc qtquickcontrols qtwebengine qtvirtualkeyboard qtquick qtserialbus
 
 buildversion = "Qt for Automation $QT_VER"
 
diff --git a/src/qtforautomation-toc.qdoc b/src/qtforautomation-toc.qdoc
index 556739a..96b20be 100644
--- a/src/qtforautomation-toc.qdoc
+++ b/src/qtforautomation-toc.qdoc
@@ -38,8 +38,9 @@
     \endomit
 
     \list
-        \li \l {Qt for Automation Overview}{Overview}
-        \li \l {Installing Qt for Automation}{Install Instructions}
+        \li \l {Qt for Automation Overview}
+        \li \l {Installing Qt for Automation}
+        \li \l {Deploying Qt for Automation Modules to Boot2Qt}
         \li \l {Related Information}
     \endlist
 */
diff --git a/src/qtforautomation.qdoc b/src/qtforautomation.qdoc
index c528366..23cd475 100644
--- a/src/qtforautomation.qdoc
+++ b/src/qtforautomation.qdoc
@@ -1,6 +1,6 @@
 /****************************************************************************
 **
-** Copyright (C) 2018 The Qt Company Ltd.
+** Copyright (C) 2019 The Qt Company Ltd.
 ** Contact: https://www.qt.io/licensing/
 **
 ** This file is part of the documentation of Qt for Automation.
@@ -30,7 +30,7 @@
 /*!
     \page qtautomation-index.html
     \title Qt for Automation
-    \nextpage {Qt for Automation Overview}{Overview}
+    \nextpage qtautomation-overview.html
 
     \e {\QTA} is a collection of software components, tools, and services
     targeted for the development of automation systems: connected
@@ -50,9 +50,9 @@
     \section1 Contents
 
     \list
-        \li \l {Qt for Automation Overview}{Overview}
-        \li \l {Installing Qt for Automation}{Install Instructions}
-        \li \l {Related Information}
+        \li \l {Qt for Automation Overview}
+        \li \l {Installing Qt for Automation}
+        \li \l {Deploying Qt for Automation Modules to Boot2Qt}
     \endlist
 
     \section1 Related Information
@@ -68,8 +68,8 @@
 /*!
     \page qtautomation-overview.html
     \title Qt for Automation Overview
-    \previouspage {Qt for Automation}
-    \nextpage {Installing Qt for Automation}
+    \previouspage qtautomation-index.html
+    \nextpage qtautomation-install.html
 
     \section1 Components
 
@@ -175,7 +175,8 @@
 /*!
     \page qtautomation-install.html
     \title Installing Qt for Automation
-    \previouspage {Qt for Automation Overview}{Overview}
+    \previouspage qtautomation-overview.html
+    \nextpage qtautomation-boot2qt.html
 
     Pre-built \QTA installation packages are available under a commercial
     license. Open source developers can build their own binaries from the
@@ -217,3 +218,39 @@
      from the list, and follow the instructions to complete the installation.
     \endlist
 */
+
+/*!
+    \page qtautomation-boot2qt.html
+    \title Deploying Qt for Automation Modules to Boot2Qt
+    \previouspage qtautomation-install.html
+
+    \QTA modules are created on top of Qt for Application development and
+    \l{Qt for Device Creation}. However, the modules are not part of the
+    Boot2Qt deployment images.
+
+    To add \QTA modules to an image using Qt Creator:
+
+    \list 1
+        \li Install \l {Qt for Device Creation} for your target, as instructed
+            in \l {Qt for Device Creation: Installation Guides}.
+        \li Install the sources of the module using the Qt online installer, as
+            instructed in \l {Installing Qt for Automation}.
+        \li Open the top-level project of the module (for example, qtmqtt.pro)
+            with Qt Creator and select the build and run kit, as instructed in
+            \l{Qt Creator: Opening Projects}.
+        \li Select \uicontrol Build > \uicontrol {Build Project}
+            to build the module, as instructed in
+            \l{Qt Creator: Building for Multiple Platforms}.
+        \li In the \uicontrol Projects mode, add \c install to the
+            \uicontrol {Make arguments} field in the build settings
+            to pass it to Make.
+            \image qtmqtt-build-settings.png
+        \li Build the project again to install the required files into the
+            \c sysroot directory of the target device.
+        \li Copy the generated .so files from the installation step to
+            \c /usr/lib on the target device to enable running applications
+            on it.
+    \endlist
+
+    You can now compile and link projects that use \QTA modules.
+*/