Doc: developing for embedded devices

Add information about Qt for Device Creation
integration with Qt Creator. Add links to the
Qt for Device Creation documentation where
appropriate.

Change-Id: Ie9be5a65697681590e2131407432f826a5ab4f2e
Reviewed-by: Rainer Keller <rainer.keller@theqtcompany.com>
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>

doc/src/linux-mobile/creator-projects-settings-run-b2qt.qdocinc

@@ -0,0 +1,19 @@
+    \section2 Specifying Run Settings for Embedded Devices
+
+    To run and debug an application on an embedded device (commercial only), you
+    must create connections from the development host to the device and add the
+    device configurations to \l{glossary-buildandrun-kit}{kits}. Select
+    \uicontrol {Manage Kits} to add devices to kits. For more information, see
+    the \l{http://doc.qt.io/QtForDeviceCreation/qtee-installation-guide.html}
+    {Installation Guide} in the
+    \l{http://doc.qt.io/QtForDeviceCreation/index.html}{Qt for Device Creation}
+    documentation.
+
+    When you run the application, \QC copies the files to the connected device.
+
+    The run settings display the path to the executable file on the development
+    host and on the device.
+
+    To execute custom commands, select \uicontrol {Add Deploy Step} >
+    \uicontrol {Custom Remote Command (via adb shell)} and enter the command to
+    execute.

doc/src/overview/creator-advanced.qdoc

@@ -48,7 +48,8 @@
         \li \l{Supported Platforms}
 
             You can install and run \QC on several operating systems to create
-            applications for multiple desktop and mobile device platforms.
+            applications for multiple desktop, embedded, and mobile device
+            platforms.
 
         \li \l{Using Other Build Systems}
 

doc/src/overview/creator-commercial-overview.qdoc

@@ -55,5 +55,7 @@
                 \li \l{Using Qt Quick UI Forms}{Export button} for exporting
                     items as alias properties
             \endlist
+        \li \l{http://doc.qt.io/QtForDeviceCreation/index.html}{Developing for
+            embedded devices}
     \endlist
 */

doc/src/overview/creator-glossary.qdoc

@@ -74,8 +74,8 @@
                 \target glossary-deploy-config
             \li Handles the packaging and copying of the necessary files to a
                 location you want to run the executable at. The files can be
-                copied to a location in the file system of the development PC or
+                copied to a location in the file system of the development PC,
-                a mobile device.
+                an embedded device, or a mobile device.
 
         \row
             \li Kit
@@ -100,8 +100,8 @@
             \li Project
                 \target glossary-project
             \li Groups together a set of source files, forms, and resource files
-                that you can build, deploy, and run for different desktop and
+                that you can build, deploy, and run for different desktop,
-                mobile device platforms, as
+                embedded, and mobile device platforms, as
                 specified by a \e {build configuration}, \e {deploy
                 configuration}, and \e {run configuration}.
 

doc/src/overview/creator-overview.qdoc

@@ -33,7 +33,7 @@
     \QC is an integrated development environment (IDE) that provides you with
     tools to design and develop applications with the Qt application framework.
     Qt is designed for developing applications and user interfaces once and
-    deploying them to several desktop and mobile operating systems. \QC
+    deploying them to several desktop, embedded, and mobile operating systems. \QC
     provides you with tools for accomplishing your tasks throughout the whole
     application development life-cycle, from creating a project to deploying the
     application to the target platforms.
@@ -86,8 +86,8 @@
                 and commands used to build the project.
 
                 \QC provides support for building, running, and deploying Qt
-                applications for desktop environment and mobile devices.
+                applications for desktop environment as well as embedded and
-                \l{glossary-buildandrun-kit}{Kits}, build,
+                 mobile devices. \l{glossary-buildandrun-kit}{Kits}, build,
                 run, and deployment settings allow you to quickly switch between
                 different setups and target platforms.
 

doc/src/overview/creator-supported-platforms.qdoc

@@ -32,7 +32,7 @@
     \title Supported Platforms
 
     You can install and run \QC on several operating systems to create
-    applications for multiple desktop and mobile device platforms.
+    applications for multiple desktop, embedded, and mobile device platforms.
 
     \section1 Development Platforms
 
@@ -113,6 +113,16 @@
 
     \endlist
 
+    \section2 Developing for Embedded Devices
+
+    The development environment supported by Qt for Device Creation is
+    Ubuntu Linux 64-bit (12.04 LTS or later). For more information about
+    the requirements for the development host, see the
+    \l{http://doc.qt.io/QtForDeviceCreation/qtee-installation-guide.html}
+    {Installation Guide} in the
+    \l{http://doc.qt.io/QtForDeviceCreation/index.html}{Qt for Device Creation}
+    documentation.
+
     \section1 Compiling from Source
 
     To build \QC from the source, see the requirements and instructions in the

doc/src/overview/creator-target-platforms.qdocinc

@@ -8,6 +8,8 @@
 
         \li Android
 
+        \li Embedded
+
         \li Generic remote Linux
 
         \li iOS
@@ -18,6 +20,20 @@
 
     \endlist
 
+    \section2 Embedded Devices
+
+    The Boot to Qt stack can be made to run on a variety of hardware. For
+    Qt for Device Creation license holders, tooling is provided to customize the
+    contents of the stack as well as to take it into desired production
+    hardware.
+
+    For more information about the supported device groups and reference devices,
+    see \l{http://doc.qt.io/QtForDeviceCreation/qtee-supported-platforms.html}
+    {Supported Platforms} in the {http://doc.qt.io/QtForDeviceCreation/index.html}
+    {Qt for Device Creation} documentation.
+
+    \section2 Mobile Devices
+
     The following table summarizes operating system support for developing
     applications for mobile device platforms.
 

doc/src/overview/creator-tech-support.qdoc

@@ -47,7 +47,8 @@
                 {List of Qt Quick Examples}
 
         \row
-            \li Develop Qt applications for desktop and mobile devices
+            \li Develop Qt applications for desktop and embedded or mobile
+                devices
             \li \l{https://www.qt.io/developers/}{Qt Developers}
 
         \row

doc/src/overview/creator-testing.qdoc

@@ -40,8 +40,8 @@
             is installed automatically and you should be ready to start
             debugging after you create a new project. However, you can
             change the setup to use debugging tools for Windows, for
-            example. You can connect mobile devices to your development PC
+            example. You can connect embedded or mobile devices to your
-            and debug processes running on the devices.
+            development host and debug processes running on the devices.
 
         \li \l{Analyzing Code}
 

doc/src/projects/creator-projects-build-run-tutorial.qdoc

@@ -37,6 +37,14 @@
     the development environment for Android or iOS. For more information, see
     \l{Connecting Android Devices} and \l{Connecting iOS Devices}.
 
+    To run an example application on an embedded device, you must set up
+    Qt for Device Creation on the development host and create connections
+    between the host and devices. For more information, see the
+    \l{http://doc.qt.io/QtForDeviceCreation/qtee-installation-guide.html}
+    {Installation Guide} in the
+    \l{http://doc.qt.io/QtForDeviceCreation/index.html}{Qt for Device Creation}
+    documentation.
+
     \list 1
 
         \li In the \uicontrol Welcome mode, select \uicontrol Examples (1).
@@ -47,7 +55,9 @@
 
             You can also search for examples. Enter the \uicontrol android or
             \uicontrol iOS keyword in the search field (2) to list all the
-            examples tested for Android or iOS.
+            examples tested for Android or iOS. To list examples that you can
+            run on embedded devices, enter the \uicontrol Boot2Qt keyword in the
+            search field (commercial only).
 
         \li To check that the application code can be compiled and linked for a
             device, click the \uicontrol {Kit Selector} and select a

doc/src/projects/creator-projects-creating.qdoc

@@ -107,8 +107,8 @@
 
                 Create a Qt Quick application that contains both QML and C++
                 code. The project includes a QQuickView.
-                You can build the application and deploy it to desktop and
+                You can build the application and deploy it to desktop,
-                mobile target platforms.
+                embedded, and mobile target platforms.
 
             \li Qt Quick Controls Application
 

doc/src/projects/creator-projects-running.qdoc

@@ -32,7 +32,8 @@
 
     By default, running an application also builds it and deploys it to a
     location from where it can be run on the desktop, on a device emulator or
-    simulator, or on a mobile device that is connected to the development PC.
+    simulator, or on an embedded device or a mobile device that is connected to
+    the development PC.
 
     To run executable files without deploying them first, select \uicontrol Build >
     \uicontrol {Run Without Deployment}. To make this the default option, deselect the

doc/src/projects/creator-projects-settings-build.qdoc

@@ -141,6 +141,12 @@
 
     \image qtcreator-build-steps-custom.png "Custom Process Step"
 
+    \section2 Executing Custom Commands
+
+    To execute custom commands when building for embedded devices, select
+    \uicontrol {Add Build Step} > \uicontrol {Custom Remote Command
+    (via adb shell)} (commercial only) and enter the command to execute.
+
     \section1 Clean Steps
 
     You can use the cleaning process to remove intermediate files. This process

doc/src/projects/creator-projects-settings-run.qdoc

@@ -59,6 +59,7 @@
     \include projects/creator-projects-settings-run-debug.qdocinc
     \include linux-mobile/creator-projects-settings-run-linux.qdocinc
     \include qnx/creator-projects-settings-run-qnx.qdocinc
+    \include linux-mobile/creator-projects-settings-run-b2qt.qdocinc
 
     \section1 Selecting the Run Environment
 

doc/src/qtcreator.qdoc

@@ -31,7 +31,8 @@
     \title Qt Creator Manual
 
     \QC provides a cross-platform, complete integrated development environment
-    (IDE) for application developers to create applications for multiple desktop
+    (IDE) for application developers to create applications for multiple
+    desktop, \l {http://doc.qt.io/QtForDeviceCreation/index.html}{embedded},
     and mobile device platforms, such as \l{Connecting Android Devices}{Android}
     and \l{Connecting iOS Devices}{iOS}. It is available for Linux, OS X and
     Windows

doc/src/qtquick/qtquick-creating.qdoc

@@ -40,8 +40,8 @@
 
         \li \uicontrol {Qt Quick Application} creates a Qt Quick 2 application
             project that can contain both QML and C++ code. The project includes
-            a QQuickView. You can build the application and deploy it to desktop
+            a QQuickView. You can build the application and deploy it to desktop,
-            and mobile target platforms.
+            embedded, and mobile target platforms.
 
         \li \uicontrol {Qt Quick Controls Application} is like
             \uicontrol {Qt Quick Application}, but using Qt Quick Controls.