diff options
author | Leena Miettinen <riitta-leena.miettinen@qt.io> | 2020-05-20 13:06:11 +0200 |
---|---|---|
committer | Leena Miettinen <riitta-leena.miettinen@qt.io> | 2020-05-27 10:49:40 +0000 |
commit | 6c9d8e619f5806b777d7aea38d010d330571fb0e (patch) | |
tree | 6a0d2566cdbe05fa38562cd29baa637d293ae133 | |
parent | dcdd64908d2af12a148b201e86612b48a809bb5d (diff) |
Doc: Improve usage of terminology related to embedded devices
Make a distinction between "Boot2Qt" and "generic remote Linux"
devices. Use "embedded devices" as a more general term.
Change-Id: Ice06e6737d6baca001a2a13a6cec7be7624dff2e
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
19 files changed, 46 insertions, 43 deletions
diff --git a/doc/qtcreator/src/cmake/creator-projects-cmake-deploying.qdocinc b/doc/qtcreator/src/cmake/creator-projects-cmake-deploying.qdocinc index a9c53ea4e2..abef5908c8 100644 --- a/doc/qtcreator/src/cmake/creator-projects-cmake-deploying.qdocinc +++ b/doc/qtcreator/src/cmake/creator-projects-cmake-deploying.qdocinc @@ -32,7 +32,7 @@ /*! //! [cmake deploying embedded] - \section1 Deploying CMake Projects to Embedded Linux Devices + \section1 Deploying CMake Projects to Generic Remote Linux Devices \QC cannot directly extract files to be installed from a CMake project. Therefore, a special deploy step is created that installs the project into diff --git a/doc/qtcreator/src/cmake/creator-projects-cmake.qdoc b/doc/qtcreator/src/cmake/creator-projects-cmake.qdoc index e5f61c7caf..d4779653c3 100644 --- a/doc/qtcreator/src/cmake/creator-projects-cmake.qdoc +++ b/doc/qtcreator/src/cmake/creator-projects-cmake.qdoc @@ -158,6 +158,6 @@ \li \l {Opening Projects} \li \l {Specifying Build Settings} \li \l {Specifying Run Settings} - \li \l {Deploying CMake Projects to Embedded Linux Devices} + \li \l {Deploying CMake Projects to Generic Remote Linux Devices} \endlist */ diff --git a/doc/qtcreator/src/linux-mobile/creator-deployment-embedded-linux.qdoc b/doc/qtcreator/src/linux-mobile/creator-deployment-embedded-linux.qdoc index 7eeb4f6820..a7efe0ba1a 100644 --- a/doc/qtcreator/src/linux-mobile/creator-deployment-embedded-linux.qdoc +++ b/doc/qtcreator/src/linux-mobile/creator-deployment-embedded-linux.qdoc @@ -38,11 +38,11 @@ \nextpage creator-deployment-qnx.html \endif - \title Deploying Applications to Embedded Linux Devices + \title Deploying Applications to Generic Remote Linux Devices - You can specify settings for deploying applications to generic Linux devices - in the project .pro file. You can view the settings in the - \uicontrol Projects mode, in \uicontrol {Run Settings}. + You can specify settings for deploying applications to generic remote + Linux devices in the project .pro file. You can view the settings in + the \uicontrol Projects mode, in \uicontrol {Run Settings}. \image qtcreator-embedded-linux-deployment-overview.png "Deploy to device" diff --git a/doc/qtcreator/src/linux-mobile/creator-projects-running-generic-linux.qdocinc b/doc/qtcreator/src/linux-mobile/creator-projects-running-generic-linux.qdocinc index f573a0de79..a744b6e9e9 100644 --- a/doc/qtcreator/src/linux-mobile/creator-projects-running-generic-linux.qdocinc +++ b/doc/qtcreator/src/linux-mobile/creator-projects-running-generic-linux.qdocinc @@ -26,14 +26,14 @@ /*! //! [running on embedded linux] - \section1 Running on Embedded Linux Devices + \section1 Running on Generic Remote Linux Devices To build the application and run it on a device: \list 1 \li Specify a connection to the device. For more information, see - \l{Connecting Embedded Linux Devices}. + \l{Connecting Generic Remote Linux Devices}. \li Click the \uicontrol Run button. diff --git a/doc/qtcreator/src/linux-mobile/creator-projects-settings-run-b2qt.qdocinc b/doc/qtcreator/src/linux-mobile/creator-projects-settings-run-b2qt.qdocinc index ea34ff83de..5a7edda0f5 100644 --- a/doc/qtcreator/src/linux-mobile/creator-projects-settings-run-b2qt.qdocinc +++ b/doc/qtcreator/src/linux-mobile/creator-projects-settings-run-b2qt.qdocinc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2017 The Qt Company Ltd. +** Copyright (C) 2020 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the Qt Creator documentation. @@ -24,11 +24,11 @@ ****************************************************************************/ /*! -//! [run settings embedded] +//! [run settings boot2qt] - \section1 Specifying Run Settings for Embedded Devices + \section1 Specifying Run Settings for Boot2Qt Devices - To run and debug an application on an embedded device (commercial only), you + To run and debug an application on a Boot2Qt 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 @@ -41,7 +41,7 @@ host and on the device. For more information on the deployment steps, see - \l{Deploying Applications to Embedded Linux Devices}. + \l{Deploying Applications to Generic Remote Linux Devices}. -//! [run settings embedded] +//! [run settings boot2qt] */ diff --git a/doc/qtcreator/src/linux-mobile/creator-projects-settings-run-linux.qdocinc b/doc/qtcreator/src/linux-mobile/creator-projects-settings-run-linux.qdocinc index 1d64706acf..4cb407f630 100644 --- a/doc/qtcreator/src/linux-mobile/creator-projects-settings-run-linux.qdocinc +++ b/doc/qtcreator/src/linux-mobile/creator-projects-settings-run-linux.qdocinc @@ -33,7 +33,7 @@ host to the device and add the device configurations to \l{glossary-buildandrun-kit}{kits}. Click \uicontrol {Manage Kits} to add devices to kits. For more information, see - \l {Connecting Embedded Linux Devices}. + \l {Connecting Generic Remote Linux Devices}. When you run the application, \QC copies the files to the connected device. diff --git a/doc/qtcreator/src/linux-mobile/linuxdev.qdoc b/doc/qtcreator/src/linux-mobile/linuxdev.qdoc index da7e6cca08..e726841c0a 100644 --- a/doc/qtcreator/src/linux-mobile/linuxdev.qdoc +++ b/doc/qtcreator/src/linux-mobile/linuxdev.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2019 The Qt Company Ltd. +** Copyright (C) 2020 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the Qt Creator documentation. @@ -33,19 +33,20 @@ \nextpage creator-developing-ios.html \endif - \title Connecting Embedded Linux Devices + \title Connecting Generic Remote Linux Devices - You can connect embedded Linux devices to the development PC to run, + You can connect generic Linux devices to the development PC to run, debug, and analyze applications built for them from \QC. If you have a tool chain for building applications for embedded Linux devices installed on the development PC, you can add it to \QC. You can then select a \l{glossary-buildandrun-kit}{kit} with \uicontrol {Embedded Linux} device type to - build applications for and run them on embedded Linux devices. + build applications for and run them on the devices. - To be able to run and debug applications on embedded Linux devices, you must - add devices and select them in the \QC \l{glossary-buildandrun-kit}{kit}. + To be able to run and debug applications on generic remote Linux devices, + you must add devices and select them in the \QC \l{glossary-buildandrun-kit} + {kit}. You use a wizard to create the connections. You can edit the settings later in \uicontrol Tools > \uicontrol Options > \uicontrol Devices > @@ -145,7 +146,7 @@ When you run the project, \QC deploys the application as specified by the deploy steps. By default, \QC copies the application files to the device. - For more information, see \l{Deploying Applications to Embedded Linux Devices}. + For more information, see \l{Deploying Applications to Generic Remote Linux Devices}. \endlist diff --git a/doc/qtcreator/src/overview/creator-only/creator-deployment-overview.qdoc b/doc/qtcreator/src/overview/creator-only/creator-deployment-overview.qdoc index 21903f7ad5..f1d40a058d 100644 --- a/doc/qtcreator/src/overview/creator-only/creator-deployment-overview.qdoc +++ b/doc/qtcreator/src/overview/creator-only/creator-deployment-overview.qdoc @@ -49,7 +49,7 @@ When you deploy the application to an Android device, \QC copies the application files to the device. In addition, you can determine the Qt libraries to use. - \li \l{Deploying Applications to Embedded Linux Devices} + \li \l{Deploying Applications to Generic Remote Linux Devices} When you deploy the application to a generic Linux-based device, \QC copies the application files to the connected device. You can test diff --git a/doc/qtcreator/src/overview/creator-only/creator-mobile-targets.qdoc b/doc/qtcreator/src/overview/creator-only/creator-mobile-targets.qdoc index 2451a07804..659a837567 100644 --- a/doc/qtcreator/src/overview/creator-only/creator-mobile-targets.qdoc +++ b/doc/qtcreator/src/overview/creator-only/creator-mobile-targets.qdoc @@ -69,7 +69,7 @@ to debug applications on them with GDB or a hardware debugger. \endif - \li \l{Connecting Embedded Linux Devices} + \li \l{Connecting Generic Remote Linux Devices} If you have a tool chain for building applications for embedded Linux devices installed on the development diff --git a/doc/qtcreator/src/overview/creator-only/creator-supported-platforms.qdoc b/doc/qtcreator/src/overview/creator-only/creator-supported-platforms.qdoc index 7013ee6cea..ce8f01a5b5 100644 --- a/doc/qtcreator/src/overview/creator-only/creator-supported-platforms.qdoc +++ b/doc/qtcreator/src/overview/creator-only/creator-supported-platforms.qdoc @@ -112,7 +112,7 @@ \endlist - \section2 Developing for Embedded Devices + \section2 Developing for Boot2Qt Devices Either Windows 7 or later or Ubuntu Linux 64-bit 12.04 LTS or later is required to install and use Qt for Device Creation. For more information diff --git a/doc/qtcreator/src/overview/creator-only/creator-target-platforms.qdocinc b/doc/qtcreator/src/overview/creator-only/creator-target-platforms.qdocinc index e54514e1c3..04c2fd936f 100644 --- a/doc/qtcreator/src/overview/creator-only/creator-target-platforms.qdocinc +++ b/doc/qtcreator/src/overview/creator-only/creator-target-platforms.qdocinc @@ -35,7 +35,7 @@ \li \l{Connecting Android Devices}{Android} \li \l{Connecting Bare Metal Devices}{Bare Metal} \li Boot2Qt - \li \l{Connecting Embedded Linux Devices}{Generic Remote Linux} + \li \l{Connecting Generic Remote Linux Devices}{Generic Remote Linux} \li \l{Connecting iOS Devices}{iOS} \li \l{Connecting MCUs}{Microcontroller Units (MCU)} (commercial only) \li \l{Connecting QNX Devices}{QNX} diff --git a/doc/qtcreator/src/projects/creator-only/creator-projects-build-run-tutorial.qdoc b/doc/qtcreator/src/projects/creator-only/creator-projects-build-run-tutorial.qdoc index c536c91cdd..1e2960eca0 100644 --- a/doc/qtcreator/src/projects/creator-only/creator-projects-build-run-tutorial.qdoc +++ b/doc/qtcreator/src/projects/creator-only/creator-projects-build-run-tutorial.qdoc @@ -43,7 +43,7 @@ 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 + To run an example application on a Boot2Qt 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} @@ -66,7 +66,7 @@ You can also use tags (3) to filter examples. For instance, enter the \uicontrol Boot2Qt tag (commercial only) in the search field - (4) to list examples that you can run on embedded devices. + (4) to list examples that you can run on Boot2Qt devices. \li To check that the application code can be compiled and linked for a device, click the \uicontrol {Kit Selector} and select a diff --git a/doc/qtcreator/src/projects/creator-only/creator-projects-generic.qdoc b/doc/qtcreator/src/projects/creator-only/creator-projects-generic.qdoc index 4a2c4c42ab..df454aaa6d 100644 --- a/doc/qtcreator/src/projects/creator-only/creator-projects-generic.qdoc +++ b/doc/qtcreator/src/projects/creator-only/creator-projects-generic.qdoc @@ -141,10 +141,11 @@ \section1 Providing Deployment Information - If you want to run your application on an embedded Linux device, you first need to - deploy your executable and possibly other files. \QC does that for you - automatically if you provide the necessary information. This works the same - way as explained for CMake \l {Deploying CMake Projects to Embedded Linux Devices}{here}, + If you want to run your application on a generic remote Linux device, + you first need to deploy your executable and possibly other files. + \QC does that for you automatically if you provide the necessary + information. This works the same way as explained for CMake + \l {Deploying CMake Projects to Generic Remote Linux Devices}{here}, except that you also need to include your application binary in the list. \section1 Creating a Run Configuration diff --git a/doc/qtcreator/src/projects/creator-only/creator-projects-settings-run.qdoc b/doc/qtcreator/src/projects/creator-only/creator-projects-settings-run.qdoc index 2591640a6d..3b564ee283 100644 --- a/doc/qtcreator/src/projects/creator-only/creator-projects-settings-run.qdoc +++ b/doc/qtcreator/src/projects/creator-only/creator-projects-settings-run.qdoc @@ -84,7 +84,7 @@ \include creator-projects-settings-run-android.qdocinc run settings android \include creator-projects-settings-run-linux.qdocinc run settings linux \include creator-projects-settings-run-qnx.qdocinc run settings qnx - \include linux-mobile/creator-projects-settings-run-b2qt.qdocinc run settings embedded + \include linux-mobile/creator-projects-settings-run-b2qt.qdocinc run settings boot2qt \section1 Selecting the Run Environment diff --git a/doc/qtcreator/src/projects/creator-only/creator-projects-targets.qdoc b/doc/qtcreator/src/projects/creator-only/creator-projects-targets.qdoc index d18817cfe4..caa3d94082 100644 --- a/doc/qtcreator/src/projects/creator-only/creator-projects-targets.qdoc +++ b/doc/qtcreator/src/projects/creator-only/creator-projects-targets.qdoc @@ -52,7 +52,7 @@ \li \l{https://doc.qt.io/QtForDeviceCreation/b2qt-installation-guides.html} {Boot2Qt Device} (commercial only) \li \l{Emulator}{Boot2Qt Emulator Device} (commercial only) - \li \l{Connecting Embedded Linux Devices}{Generic Remote Linux Device} + \li \l{Connecting Generic Remote Linux Devices}{Generic Remote Linux Device} \li \l{Connecting iOS Devices}{iOS Device} \li iOS Simulator \li \l{Connecting MCUs}{MCU Device} (commercial only) diff --git a/doc/qtcreator/src/qnx/creator-deployment-qnx.qdoc b/doc/qtcreator/src/qnx/creator-deployment-qnx.qdoc index 19e1217e63..232a371e26 100644 --- a/doc/qtcreator/src/qnx/creator-deployment-qnx.qdoc +++ b/doc/qtcreator/src/qnx/creator-deployment-qnx.qdoc @@ -41,7 +41,7 @@ \title Deploying Applications to QNX Neutrino Devices You can deploy applications to QNX Neutrino devices in the way that is - described in \l{Deploying Applications to Embedded Linux Devices}. + described in \l{Deploying Applications to Generic Remote Linux Devices}. \image qtcreator-qnx-deployment.png "Deploy to device" diff --git a/doc/qtcreator/src/qnx/creator-developing-qnx.qdoc b/doc/qtcreator/src/qnx/creator-developing-qnx.qdoc index e535c04e04..6af72ab253 100644 --- a/doc/qtcreator/src/qnx/creator-developing-qnx.qdoc +++ b/doc/qtcreator/src/qnx/creator-developing-qnx.qdoc @@ -42,8 +42,9 @@ \section1 Adding a QNX Neutrino Device in \QC - Adding a QNX Neutrino device is very similar to \l{Connecting Embedded - Linux Devices}, except you need to select \uicontrol {QNX Device} in the + Adding a QNX Neutrino device is very similar to + \l{Connecting Generic Remote Linux Devices}, except that + you need to select \uicontrol {QNX Device} in the \uicontrol {Device Configuration} wizard. \section1 Adding Kits for QNX Devices diff --git a/doc/qtcreator/src/qtcreator-toc.qdoc b/doc/qtcreator/src/qtcreator-toc.qdoc index 2b17c2c5da..021b7052f8 100644 --- a/doc/qtcreator/src/qtcreator-toc.qdoc +++ b/doc/qtcreator/src/qtcreator-toc.qdoc @@ -196,14 +196,14 @@ \li \l{Deploying to Devices} \list \li \l{Deploying Applications to Android Devices} - \li \l{Deploying Applications to Embedded Linux Devices} + \li \l{Deploying Applications to Generic Remote Linux Devices} \li \l{Deploying Applications to QNX Neutrino Devices} \endlist \li \l{Connecting Devices} \list \li \l{Connecting Android Devices} \li \l{Connecting Bare Metal Devices} - \li \l{Connecting Embedded Linux Devices} + \li \l{Connecting Generic Remote Linux Devices} \li \l{Connecting iOS Devices} \li \l{Connecting MCUs} \li \l{Connecting QNX Devices} diff --git a/doc/qtcreator/src/qtquick/qtquick-live-preview-devices.qdoc b/doc/qtcreator/src/qtquick/qtquick-live-preview-devices.qdoc index 8cf7f9303f..0bf837ee8c 100644 --- a/doc/qtcreator/src/qtquick/qtquick-live-preview-devices.qdoc +++ b/doc/qtcreator/src/qtquick/qtquick-live-preview-devices.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2019 The Qt Company Ltd. +** Copyright (C) 2020 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the Qt Design Studio documentation. @@ -34,7 +34,7 @@ To preview UIs on Android devices, you need to enable USB debugging on them and connect them to your system with a USB cable. \endomit - To preview UIs on embedded devices, you need to connect the devices to your + To preview UIs on Boot2Qt devices, you need to connect the devices to your system with a USB cable, or a wired or wireless connection, depending on the device, and configure connections to them. The necessary kits have been predefined and you only need to enable them for your current project. @@ -79,9 +79,9 @@ device. \endomit - \section2 Previewing on Embedded Devices + \section2 Previewing on Boot2Qt Devices - You can preview UIs on embedded devices that are supported by + You can preview UIs on Boot2Qt devices that are supported by \l{Qt for Device Creation}. For a list of supported devices, see \l{https://doc.qt.io/QtForDeviceCreation/qtee-supported-platforms.html#reference-target-devices} {Reference Target Devices}. |