feedc0de/qt-creator
1
0
Fork 0
forked from qt-creator/qt-creator
Code Pull Requests Activity

Doc: Restructure info about remote Linux devices

Browse Source 
Task-number: QTCREATORBUG-29361
Change-Id: If78cdeb28b0efb522aea871ae9f20e7742afd127
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
This commit is contained in:
Leena Miettinen
2024-05-06 10:46:43 +02:00
parent d96615eee8
commit f9b097436b
21 changed files with 323 additions and 269 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
doc/qtcreator/src/appman/creator-appman-how-to-run.qdoc
View File

@@ -149,6 +149,6 @@
in-process runtime as an individual process. in-process runtime as an individual process.
\sa {Activate kits for a project}, {Connecting Boot2Qt Devices}, \sa {Activate kits for a project}, {Connecting Boot2Qt Devices},
{Connecting Remote Linux Devices}, {Enable and disable plugins}, {Remote Linux}{How To: Develop for remote Linux}, {Enable and disable plugins},
{Run on many platforms}, {Debugging}, {Debuggers}, {Debugger}, {Profiling QML Applications} {Run on many platforms}, {Debugging}, {Debuggers}, {Debugger}, {Profiling QML Applications}
*/ */

4
doc/qtcreator/src/external-resources/external-resources.qdoc
View File

@@ -213,3 +213,7 @@
\externalpage https://valgrind.org/docs/manual/manual-core.html#manual-core.suppress \externalpage https://valgrind.org/docs/manual/manual-core.html#manual-core.suppress
\title Suppressing Errors \title Suppressing Errors
*/ */
/*!
\externalpage https://www.openssh.com/
\title OpenSSH
*/

23
doc/qtcreator/src/howto/creator-only/creator-how-tos.qdoc
View File

@@ -86,31 +86,42 @@
embedded or mobile platform on the computer, and use \QOI to embedded or mobile platform on the computer, and use \QOI to
install Qt libraries that are built for the platform. Then add a install Qt libraries that are built for the platform. Then add a
kit with the toolchain and the Qt version for the device's architecture. kit with the toolchain and the Qt version for the device's architecture.
When possible, \QOI creates suitable kits for you. When possible, \QOI creates suitable kits for you. Connect the devices
to the computer to run, debug, and analyze applications on them.
\section2 Android \section2 Android
Install \l {Qt for Android} and Android tools. Install \l {Qt for Android} and Android tools, and connect Android devices to
the computer.
\generatelist creator-how-to-android \generatelist creator-how-to-android
\section2 Bare Metal \section2 Bare Metal
Run and debug applications on small Linux devices that are not supported
by the remote Linux device plugin by using GDB or a hardware debugger.
\generatelist creator-how-to-bare-metal \generatelist creator-how-to-bare-metal
\section2 iOS \section2 iOS
Install \l {Qt for iOS} and Xcode. Install \l {Qt for iOS} and Xcode, and connect iOS devices to the computer.
\generatelist creator-how-to-ios \generatelist creator-how-to-ios
\section2 MCUs \section2 MCUs
Install \l {Qt for MCUs} and connect devices to the computer to run and Install \l {Qt for MCUs}, and connect microcontrollers to the computer.
debug applications on them.
\generatelist creator-how-to-mcu \generatelist creator-how-to-mcu
\section2 Remote Linux
Add kits for toolchains for building applications for generic Linux
devices, and connect the devices to the computer.
\generatelist creator-how-to-remote-linux
\section1 Edit Code \section1 Edit Code
The code editor offers useful features for editing C++ and QML code, such The code editor offers useful features for editing C++ and QML code, such
@@ -146,7 +157,7 @@
\QC groups build and run specific settings as kits to make cross-platform \QC groups build and run specific settings as kits to make cross-platform
development easier. Each kit consists of a set of values that define one development easier. Each kit consists of a set of values that define one
environment, such as a device, tool chain, Qt version, and debugger command environment, such as a device, toolchain, Qt version, and debugger command
to use. to use.
\generatelist creator-how-to-manage-kits \generatelist creator-how-to-manage-kits

6
doc/qtcreator/src/linux-mobile/b2qtdev.qdoc
View File

@@ -60,15 +60,15 @@
\section2 Protecting Connections \section2 Protecting Connections
You can protect the connections between \QC and a device by using an You can protect the connections between \QC and a device by using an
\l{https://www.openssh.com/}{OpenSSH} connection. OpenSSH is a \l{OpenSSH} connection. OpenSSH is a
connectivity tool for remote login using the SSH protocol. The OpenSSH connectivity tool for remote login using the SSH protocol. The OpenSSH
suite is not delivered with \QC, so you must download it and install it suite is not delivered with \QC, so you must download it and install it
on the development PC. Then, you must configure the paths to the tools in on the development PC. Then, you must configure the paths to the tools in
\QC. For more information, see \l {Configuring SSH Connections}. \QC. For more information, see \l {Configure SSH connections}.
You need either a password or an SSH public and private key pair for You need either a password or an SSH public and private key pair for
authentication. If you do not have an SSH key, you can use the \c ssh-keygen authentication. If you do not have an SSH key, you can use the \c ssh-keygen
tool to create it in \QC. For more information, see \l {Generating SSH Keys}. tool to create it in \QC. For more information, see \l {Generate SSH keys}.
\QC does not store passwords. If you use password authentication, you may \QC does not store passwords. If you use password authentication, you may
need to enter the password upon every connection to the device, or if need to enter the password upon every connection to the device, or if

2
doc/qtcreator/src/linux-mobile/creator-deployment-embedded-linux.qdoc
View File

@@ -113,5 +113,5 @@
uploads the tarball to the device and extracts it. uploads the tarball to the device and extracts it.
\sa {Build and Run}{How To: Build and Run}, \sa {Build and Run}{How To: Build and Run},
{Connecting Remote Linux Devices}, {Remote Linux Run Settings} {Remote Linux}{How To: Develop for remote Linux}, {Remote Linux Run Settings}
*/ */

45
doc/qtcreator/src/linux-mobile/creator-embedded-platforms.qdoc
View File

@@ -14,17 +14,17 @@
You can develop applications for the following embedded platforms: You can develop applications for the following embedded platforms:
\list \list
\li \l {Bare Metal} \li Bare Metal
\li \l {Boot2Qt} \li \l {Boot2Qt}
\li \l {Remote Linux} \li Remote Linux
\li \l {Microcontroller Units (MCU)} \li Microcontrollers (MCU)
\li \l QNX \li \l QNX
\endlist \endlist
You must install the tool chain for building applications for the targeted You must install the toolchain for building applications for the targeted
embedded platform on the development PC and use \QMT to embedded platform on the development PC and use \QMT to
install Qt libraries that are built for the platform. You can then add a install Qt libraries that are built for the platform. You can then add a
\l{glossary-buildandrun-kit}{kit} with the tool chain and the Qt version \l{glossary-buildandrun-kit}{kit} with the toolchain and the Qt version
for the device's architecture. When possible, \QMT creates for the device's architecture. When possible, \QMT creates
suitable kits for you. suitable kits for you.
@@ -48,38 +48,6 @@
\li \l{Run in Qt Application Manager} \li \l{Run in Qt Application Manager}
\endlist \endlist
\section1 Remote Linux
You must have a tool chain for building applications for embedded Linux
devices installed on the development PC.
The following topics have more information about developing applications
for remote Linux devices:
\list
\li \l{Adding Docker Devices}
\li \l{Connecting Remote Linux Devices}
\li \l{Remote Linux Deploy Configuration}
\li \l{Remote Linux Run Settings}
\li \l{Run on remote Linux devices}
\li \l{Run in Qt Application Manager}
\endlist
\section1 Microcontroller Units (MCU)
You need the GNU Arm Embedded GCC compiler, libraries, and other GNU tools
necessary for bare metal software development on devices based on the Arm
Cortex-M processors.
The following topics have more information about developing applications
for MCUs:
\list
\li \l{Connecting MCUs}
\li \l{MCUs}{How To: Develop for MCUs}
\li \l{https://doc.qt.io/QtForMCUs/index.html}{\QMCU}
\endlist
\section1 QNX \section1 QNX
The QNX Neutrino RTOS has more command-line tools The QNX Neutrino RTOS has more command-line tools
@@ -98,5 +66,6 @@
\li \l{Qt for QNX} \li \l{Qt for QNX}
\endlist \endlist
\sa {Develop for Devices}{How To: Develop for Devices}, {Supported Platforms} \sa {Develop for Devices}{How To: Develop for Devices}, {Devices},
{Supported Platforms}
*/ */

6
doc/qtcreator/src/linux-mobile/creator-projects-how-to-run-generic-linux.qdoc
View File

@@ -5,7 +5,7 @@
\page creator-how-to-run-on-remote-linux.html \page creator-how-to-run-on-remote-linux.html
\previouspage creator-how-tos.html \previouspage creator-how-tos.html
\ingroup creator-how-to-run \ingroup creator-how-to-remote-linux
\title Run on remote Linux devices \title Run on remote Linux devices
@@ -19,7 +19,7 @@
\endlist \endlist
\QC uses the compiler from the kit (tool chain) to build the application. \QC uses the compiler from the kit (toolchain) to build the application.
\QC copies the application files to the connected device and runs the \QC copies the application files to the connected device and runs the
application. The application views are application. The application views are
@@ -34,6 +34,6 @@
Debugging works transparently if GDB server is installed on the device and Debugging works transparently if GDB server is installed on the device and
it is compatible with the GDB on the host. it is compatible with the GDB on the host.
\sa {Connecting Remote Linux Devices}, {Run on many platforms}, {Compilers}, \sa {Remote Linux}{How To: Develop for remote Linux}, {Run on many platforms}, {Compilers},
{Embedded Platforms}, {kit-preferences}{Kits} {Embedded Platforms}, {kit-preferences}{Kits}
*/ */

4
doc/qtcreator/src/linux-mobile/creator-projects-settings-run-linux.qdoc
View File

@@ -19,7 +19,7 @@
connections from the development host to the device and add the device connections from the development host to the device and add the device
configurations to kits. Select \uicontrol {Manage Kits} to add devices configurations to kits. Select \uicontrol {Manage Kits} to add devices
to kits. For more information, see to kits. For more information, see
\l {Connecting Remote Linux Devices}. \l {Remote Linux}{How To: Develop for remote Linux}.
When you run the application, \QC copies the files to the connected device. When you run the application, \QC copies the files to the connected device.
@@ -38,5 +38,5 @@
running X11 client on a local display. running X11 client on a local display.
\sa {Activate kits for a project}, {Configure projects for running}, {kits-tab}{Kits}, \sa {Activate kits for a project}, {Configure projects for running}, {kits-tab}{Kits},
{Connecting Remote Linux Devices} {Remote Linux}{How To: Develop for remote Linux}
*/ */

82
doc/qtcreator/src/linux-mobile/linuxdev-keys.qdoc Normal file
View File

@@ -0,0 +1,82 @@
// Copyright (C) 2024 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
\page creator-how-to-configure-ssh.html
\previouspage creator-how-tos.html
\ingroup creator-how-to-remote-linux
\title Configure SSH connections
To protect the connections between \QC and a device, install the \l{OpenSSH}
suite, which includes the \c ssh, \c sftp, and \c ssh-keygen tools on the
computer.
SSH connections are established via an OpenSSH client running in master
mode, if possible. By default, multiple sessions are shared over a single SSH
onnection. Establishing a connection once and then re-using it for subsequent
run and deploy procedures reduces connection setup overhead particularly
with embedded devices. Because connection sharing is not supported on
Windows, a new SSH connection is created for each deploy or run procedure.
To set the paths to the directories where the tools are installed:
\list 1
\li Go to \preferences > \uicontrol Devices > \uicontrol SSH.
\image qtcreator-ssh-options.png "SSH preferences"
\li Clear \uicontrol {Enable connection sharing} to
create a new SSH connection for each deploy and run procedure. This
option is grayed on Windows, where connection sharing is not
supported.
\li In \uicontrol {Connection sharing timeout}, specify the
timeout for reusing the SSH connection in minutes.
\li In \uicontrol {Path to ssh executable}, enter the path
to the directory where the OpenSSH executable is installed.
\li In \uicontrol {Path to sftp executable}, enter the path
to the directory where the SFTP executable is installed.
\li In \uicontrol {Path to ssh-askpass executable}, enter the
path to the directory where the ssh-askpass executable is installed.
Usually, you can use the default path that points to the
implementation of the tool delivered with \QC, qtc-askpass.
\li In \uicontrol {Path to ssh-keygen executable}, enter the
path to the directory where the ssh-keygen executable is installed.
\endlist
\sa {Remote Linux}{How To: Develop for remote Linux},
{Developing for Remote Linux Devices}
*/
/*!
\page creator-how-to-generate-ssh-keys.html
\previouspage creator-how-tos.html
\ingroup creator-how-to-remote-linux
\title Generate SSH Keys
To protect the connections between \QC and a device, use \l{OpenSSH}.
If you do not have an SSH public and private key pair, you can generate it
in \QC. The connection wizard can create the key pair for you, or you can
create it separately.
You can specify key length and the key algorithm, RSA or ECDSA.
If you only use the keys to protect connections to the emulator or
device, you can use the default values.
\list 1
\li Go to \preferences > \uicontrol Devices > \uicontrol Devices
\li Select \uicontrol {Create New}.
\image qtcreator-ssh-key-configuration.png {SSH Key Configuration dialog}
\li In \uicontrol {Private key file}, select the location to save
the private key.
\uicontrol {Public key file} displays the location to save the
corresponding public key.
\li Select \uicontrol {Generate And Save Key Pair} to generate and save the
keys at the specified locations.
\endlist
\sa {Remote Linux}{How To: Develop for remote Linux},
{Developing for remote Linux devices}
*/

80
doc/qtcreator/src/linux-mobile/linuxdev-keys.qdocinc
View File

@@ -1,80 +0,0 @@
// Copyright (C) 2019 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
//! [configuring ssh]
\section2 Configuring SSH Connections
SSH connections are established via an OpenSSH client running in master
mode, if possible. Connection sharing is enabled by default to allow
sharing multiple sessions over a single SSH connection. This way, a
connection is only established once and then re-used by subsequent run
and deploy procedures, saving connection setup overhead particularly
with embedded devices. Because connection sharing is not supported on
Windows, a new SSH connection is created for each deploy or run procedure.
To create SSH connections, you must install the \l{https://www.openssh.com/}
{OpenSSH} suite, which includes the ssh, sftp, and ssh-keygen tools on the
development PC.
To tell \QC where it can find the tools, specify the paths to the
directories where the tools are installed in \preferences >
\uicontrol Devices > \uicontrol SSH:
\image qtcreator-ssh-options.png "SSH preferences"
\list
\li Deselect the \uicontrol {Enable connection sharing} check box to
create a new SSH connection for each deploy and run procedure. This
option is grayed on Windows, where connection sharing is not
supported.
\li In the \uicontrol {Connection sharing timeout} field, specify the
timeout for reusing the SSH connection in minutes.
\li In the \uicontrol {Path to ssh executable} field, enter the path
to the directory where the OpenSSH executable is installed.
\li In the \uicontrol {Path to sftp executable} field, enter the path
to the directory where the SFTP executable is installed.
\li In the \uicontrol {Path to ssh-askpass executable} field, enter the
path to the directory where the ssh-askpass executable is installed.
Usually, you can use the default path that points to the
implementation of the tool delivered with \QC, qtc-askpass.
\li In the \uicontrol {Path to ssh-keygen executable} field, enter the
path to the directory where the ssh-keygen executable is installed.
\endlist
//! [configuring ssh]
//! [generating ssh keys]
\section2 Generating SSH Keys
If you do not have an SSH public and private key pair, you can generate it
in \QC. The connection wizard can create the key pair for you, or you can
create it separately.
You can specify key length and the key algorithm, RSA or ECDSA.
If you only use the keys to protect connections to the emulator or
device, you can use the default values.
\list 1
\li Select \preferences > \uicontrol Devices
> \uicontrol Devices > \uicontrol {Create New}.
\image qtcreator-ssh-key-configuration.png "SSH Key Configuration dialog"
\li In the \uicontrol {Private key file} field, select the location to save
the private key.
The \uicontrol {Public key file} field displays the location to save the
corresponding public key.
\li Select \uicontrol {Generate And Save Key Pair} to generate and save the
keys at the specified locations.
\endlist
//! [generating ssh keys]
*/

26
doc/qtcreator/src/linux-mobile/linuxdev-processes.qdoc Normal file
View File

@@ -0,0 +1,26 @@
// Copyright (C) 2024 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
\page creator-how-to-manage-device-processes.html
\previouspage creator-how-tos.html
\ingroup creator-how-to-remote-linux
\title Manage device processes
To view and end processes running on embedded platforms:
\list 1
\li Go to \preferences > \uicontrol Devices > \uicontrol Devices.
\li Select an embedded device.
\image qtcreator-preferences-devices-remote-linux.webp {Remote Linux Device in Devices}
\li Select \uicontrol {Show Running Processes}.
\li Filter the processes by name or ID.
\li To update the process list, select \uicontrol {Update List}.
\li To end a process, select it in the list, and then select
\uicontrol {Kill Process}.
\endlist
\sa {Develop for Devices}{How To: Develop for Devices}, {Devices}
*/

22
doc/qtcreator/src/linux-mobile/linuxdev-processes.qdocinc
View File

@@ -1,22 +0,0 @@
// Copyright (C) 2019 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
//! [managing device processes]
\section2 Managing Device Processes
You can view processes running on devices and kill them. Select
\preferences > \uicontrol Devices >
\uicontrol Devices > \uicontrol {Show Running Processes}.
You can filter the processes by name or ID in the
\uicontrol {List of Processes} dialog.
To update the process list, select \uicontrol {Update List}.
To kill a process, select it in the list, and then select \uicontrol {Kill
Process}.
//! [managing device processes]
*/

215
doc/qtcreator/src/linux-mobile/linuxdev.qdoc
View File

@@ -1,122 +1,87 @@
// Copyright (C) 2021 The Qt Company Ltd. // Copyright (C) 2024 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*! /*!
\page creator-developing-generic-linux.html \page creator-developing-generic-linux.html
\previouspage creator-developing-qnx.html \previouspage creator-reference.html
\nextpage creator-setup-webassembly.html
\title Connecting Remote Linux Devices \ingroup creator-reference-devices
You can connect generic Linux devices to the development PC to run, \title Developing for Remote Linux Devices
\brief Connect generic Linux devices to the computer to run,
debug, and analyze applications built for them from \QC. debug, and analyze applications built for them from \QC.
If you have a tool chain for building applications for embedded Linux If you have a toolchain for building applications for embedded Linux
devices installed on the development PC, you can add devices installed on the computer, add it to a \l{Kits}{kit}
it to \QC. You can then select a \l{glossary-buildandrun-kit}{kit}
with the device type \uicontrol {Remote Linux Device} to with the device type \uicontrol {Remote Linux Device} to
build applications for and run them on the devices. build applications for and run them on the devices.
To be able to run and debug applications on remote Linux devices, Use a wizard to connect remote Linux devices to the computer. You can edit
you must add devices and select them in the \QC \l{glossary-buildandrun-kit} the settings later in \preferences > \uicontrol Devices > \uicontrol Devices.
{kit}.
You use a wizard to create the connections. You can edit the settings later \image qtcreator-preferences-devices-remote-linux.webp {Remote Linux Device in Devices}
in \preferences > \uicontrol Devices >
\uicontrol Devices.
\image qtcreator-preferences-devices-remote-linux.webp "Remote Linux Device in the Devices tab" \section1 Protecting Device Connections
You can protect the connections between \QC and a device by using an To protect the connections between \QC and a device, use \l{OpenSSH} for
\l{https://www.openssh.com/}{OpenSSH} connection. OpenSSH is a remote login over the SSH protocol. The OpenSSH suite is not delivered with
connectivity tool for remote login using the SSH protocol. The OpenSSH \QC, so download it and install it on the computer. Then, configure the paths
suite is not delivered with \QC, so you must download it and install it to the tools in \QC.
on the development PC. Then, you must configure the paths to the tools in
\QC. For more information, see \l {Configuring SSH Connections}.
You need either a password or an SSH public and private key pair for You need either a password or an SSH public and private key pair for
authentication. If you do not have an SSH key, you can use the ssh-keygen authentication. If you do not have an SSH key, use the \c ssh-keygen
tool to create it in \QC. For more information, see \l {Generating SSH Keys}. tool to create it in \QC.
\note \QC does not store passwords, so if you use password authentication, \note \QC does not store passwords, so if you use password authentication,
you may need to enter the password on every connection to the device, you may need to enter the password on every connection to the device,
or, if caching is enabled, at every \QC restart. or, if caching is enabled, at every \QC restart.
To configure connections between \QC and a remote Linux device and to \sa {Adding Docker Devices}, {Remote Linux}{How To: Develop for remote Linux},
specify build and run settings for the device: {Run in Qt Application Manager}, {Remote Linux Deploy Configuration},
{Remote Linux Run Settings}
*/
/*!
\page creator-how-to-connect-remote-linux.html
\previouspage creator-how-tos.html
\ingroup creator-how-to-remote-linux
\title Connect remote Linux devices
Create connections between generic Linux devices and \QC to run, debug, and
analyze applications on them.
To configure connections between \QC and a remote Linux device:
\list 1 \list 1
\li Make sure that your device can be reached via an IP address. \li Make sure that your device can be reached via an IP address.
\li Select \preferences > \uicontrol Kits > \li Go to \preferences > \uicontrol Kits > \uicontrol {Qt Versions}.
\uicontrol {Qt Versions} > \uicontrol Add to add the Qt version
for embedded Linux.
\li Select \preferences > \uicontrol Kits > \li Select \uicontrol Add to add the Qt version for embedded Linux.
\uicontrol Compilers > \uicontrol Add to add the compiler for
building the applications.
\li To deploy applications and run them remotely on devices, specify \li Go to \preferences > \uicontrol Kits > \uicontrol Compilers.
parameters for accessing the devices:
\list a \li Select \uicontrol Add to add the compiler for building the
applications.
\li Select \preferences > \li Go to \preferences > \uicontrol Devices > \uicontrol Devices.
\uicontrol Devices > \uicontrol Devices > \uicontrol Add >
\uicontrol {Remote Linux Device}
> \uicontrol {Start Wizard}.
\image qtcreator-preferences-devices-remote-linux-connection.webp "Connection Data wizard" \li Select \uicontrol Add to add a remote Linux device.
\li In \uicontrol {The name to identify this configuration}, \li Go to \preferences > \uicontrol Kits.
enter a name for the connection.
\li In \uicontrol {The device's host name or IP address}, \li Select \uicontrol Add to add a kit for building for the device.
enter the host name or IP address of the device.
This value will be available in the variable \c %{Device:HostAddress}.
\li In \uicontrol {The device's SSH port number}, enter the port \li Select the Qt version, compiler, and device that you added above.
number to use for SSH connections. This value will be
available in the variable \c %{Device:SshPort}.
\li In \uicontrol {The username to log into the device},
enter the username to log into the device and run the
application as.
This value will be available in the variable \c %{Device:UserName}.
\li Select \uicontrol {Next} to open the \li In \uicontrol {Run device type}, select
\uicontrol {Key Deployment} dialog. \uicontrol {Remote Linux Device}.
\image qtcreator-preferences-devices-remote-linux-key-deployment.webp "Key Deployment dialog" \li To build on the remote device, select \uicontrol {Remote Linux Device}
\li In \uicontrol {Private key file}, select a private key file
to use for authentication. This value will be available in
the variable \c %{Device:PrivateKeyFile}.
\li If you do not have a public-private key pair, select
\uicontrol {Create New Key Pair}. For more information,
see \l{Generating SSH Keys}.
\li Select \uicontrol {Deploy Public Key} to copy the public
key to the device.
\li Select \uicontrol {Next} to create the connection.
\endlist
All of these parameters can be edited later, as well as additional ones that the
wizard does not show because there are sensible default values.
To add a device without using the wizard, select
\uicontrol {Add Remote Linux Device} in the pull-down
menu of the \uicontrol Add button.
\li Select \preferences > \uicontrol Kits >
\uicontrol Add to add a kit for building for the device. Select the
Qt version, compiler, and device that you added above, and select
\uicontrol {Remote Linux Device} in \uicontrol {Run device type}.
To build on the remote device, select \uicontrol {Remote Linux Device}
also in \uicontrol {Build device}. also in \uicontrol {Build device}.
\li To specify build settings: \li To specify build settings:
@@ -134,13 +99,85 @@
\li Select \uicontrol Run to specify run settings. Usually, you can use \li Select \uicontrol Run to specify run settings. Usually, you can use
the default settings. the default settings.
When you run the project, \QC deploys the application as specified by the When you run the project, \QC deploys the application as specified by
deploy steps. By default, \QC copies the application files to the device. the deploy steps.
For more information, see \l{Remote Linux Deploy Configuration}.
\endlist \endlist
\include linux-mobile/linuxdev-keys.qdocinc configuring ssh \sa {Remote Linux}{How To: Develop for remote Linux},
\include linux-mobile/linuxdev-keys.qdocinc generating ssh keys {Manage Kits}{How To: Manage Kits}, {Developing for Remote Linux Devices},
\include linux-mobile/linuxdev-processes.qdocinc managing device processes {Remote Linux Deploy Configuration}, {Remote Linux Run Settings}
*/
/*!
\page creator-how-to-add-remote-linux.html
\previouspage creator-how-tos.html
\ingroup creator-how-to-remote-linux
\title Add remote Linux devices
Create connections between \QC and generic Linux devices to run, debug, and
analyze applications on them.
\section1 Use a wizard to add a device
To use a wizard to add a remote Linux device:
\list 1
\li Go to \preferences > \uicontrol Devices > \uicontrol Devices.
\li Select \uicontrol Add > \uicontrol {Remote Linux Device}
> \uicontrol {Start Wizard}.
\image qtcreator-preferences-devices-remote-linux-connection.webp {Connection Data wizard}
\li In \uicontrol {The name to identify this configuration},
enter a name for the connection.
\li In \uicontrol {The device's host name or IP address},
enter the host name or IP address of the device.
This value will be available in the variable \c %{Device:HostAddress}.
\li In \uicontrol {The device's SSH port number}, enter the port
number to use for SSH connections. This value will be
available in the variable \c %{Device:SshPort}.
\li In \uicontrol {The username to log into the device},
enter the username to log into the device and run the
application as.
This value will be available in the variable \c %{Device:UserName}.
\li Select \uicontrol {Next} to open the
\uicontrol {Key Deployment} dialog.
\image qtcreator-preferences-devices-remote-linux-key-deployment.webp "Key Deployment dialog"
\li In \uicontrol {Private key file}, select a private key file
to use for authentication. This value will be available in
the variable \c %{Device:PrivateKeyFile}.
\li If you do not have a public-private key pair, select
\uicontrol {Create New Key Pair}. For more information,
see \l{Generate SSH keys}.
\li Select \uicontrol {Deploy Public Key} to copy the public
key to the device.
\li Select \uicontrol {Next} to create the connection.
\endlist
You can change the preferences later, as well as additional ones that the
wizard does not show because they have sensible default values.
\section1 Manually add a device
To add a device without using the wizard, select
\uicontrol {Add Remote Linux Device} in the pull-down
menu of the \uicontrol Add button.
\sa {Remote Linux}{How To: Develop for remote Linux},
{Developing for Remote Linux Devices},
{Remote Linux Deploy Configuration}
*/ */

5
doc/qtcreator/src/mcu/creator-mcu-dev.qdoc
View File

@@ -91,7 +91,8 @@
\li 1.0 \li 1.0
\endtable \endtable
\sa {Enable and disable plugins}, {MCUs}{How To: Develop for MCUs} \sa {Enable and disable plugins}, {MCUs}{How To: Develop for MCUs},
{Developing for MCUs}, {\QMCU}
*/ */
/*! /*!
@@ -157,7 +158,7 @@
\QC automatically adds a default MCU device when you select \QC automatically adds a default MCU device when you select
\uicontrol Apply in the \uicontrol MCU tab after configuring the \uicontrol Apply in the \uicontrol MCU tab after configuring the
MCU tool chain. MCU toolchain.
\image qtcreator-mcu-device.png {MCU devices} \image qtcreator-mcu-device.png {MCU devices}

4
doc/qtcreator/src/overview/creator-only/creator-mobile-targets.qdoc
View File

@@ -67,9 +67,9 @@
supported for QNX Neutrino devices, and requires the QNX SDK to be supported for QNX Neutrino devices, and requires the QNX SDK to be
installed on the development PC. installed on the development PC.
\li \l{Connecting Remote Linux Devices} \li \l{Developing for Remote Linux Devices}
If you have a tool chain for building applications for embedded If you have a toolchain for building applications for embedded
Linux devices installed on the development Linux devices installed on the development
PC, you can add it and the device to \QC. PC, you can add it and the device to \QC.

36
doc/qtcreator/src/overview/creator-only/creator-overview.qdoc
View File

@@ -198,6 +198,34 @@
For more information, see \l{Build and Run}{How To: Build and Run}, For more information, see \l{Build and Run}{How To: Build and Run},
\l{Build Systems}, \l{Build Configurations}, and \l{Run Configurations}. \l{Build Systems}, \l{Build Configurations}, and \l{Run Configurations}.
\section1 Embedded Platforms
You can develop applications for the following embedded platforms:
\list
\li \l {Developing for Bare Metal Devices}{Bare Metal}
\li \l {Boot2Qt}
\li \l {Remote Linux}
\li \l {Developing for MCUs}{Microcontrollers (MCU)}
\li \l {Connecting QNX Devices}{QNX}
\endlist
Install the toolchain for building applications for the targeted
embedded platform on the computer, and then use \QOI to install Qt
libraries that are built for the platform. Add a kit with the toolchain and
the Qt version for the device's architecture. When possible, \QOI creates
suitable kits for you.
You can connect embedded devices to the computer and select the appropriate
kit to run, debug, and analyze applications built for them from \QC.
\e {Deploy configurations} handle the packaging and copying of the necessary
files to a location you want to run the executable at, such as the file
system of a device.
For more information, see \l{Develop for Devices}{How To: Develop for Devices}
and \l{Devices}.
\section2 Mobile Platforms \section2 Mobile Platforms
You can develop applications for the following mobile platforms: You can develop applications for the following mobile platforms:
@@ -207,18 +235,14 @@
\li \l iOS \li \l iOS
\endlist \endlist
Install the tool chain for building applications for the targeted mobile Install the toolchain for building applications for the targeted mobile
platform on the computer, and then use \QOI to install Qt libraries that are platform on the computer, and then use \QOI to install Qt libraries that are
built for the platform. Add a kit with the tool chain and the Qt version for built for the platform. Add a kit with the toolchain and the Qt version for
the device's architecture. When possible, \QOI creates suitable kits for you. the device's architecture. When possible, \QOI creates suitable kits for you.
You can connect mobile devices to the computer and select the You can connect mobile devices to the computer and select the
appropriate kit to build, run, debug, and analyze applications from \QC. appropriate kit to build, run, debug, and analyze applications from \QC.
\e {Deploy configurations} handle the packaging and copying of the necessary
files to a location you want to run the executable at, such as the file
system of a device.
Before starting application development, analyze and define the requirements, Before starting application development, analyze and define the requirements,
scope, and functionality of the application to ensure efficient functionality scope, and functionality of the application to ensure efficient functionality
and a smooth user experience on mobile devices. and a smooth user experience on mobile devices.

15
doc/qtcreator/src/overview/creator-only/creator-supported-platforms.qdoc
View File

@@ -42,18 +42,13 @@
\li \image ok.png \li \image ok.png
\li \image ok.png \li \image ok.png
\li \image ok.png \li \image ok.png
\row
\li \l{Remote Linux}
\li \image ok.png
\li \image ok.png
\li \image ok.png
\row \row
\li \l iOS \li \l iOS
\li \li
\li \image ok.png \li \image ok.png
\li \li
\row \row
\li \l{Microcontroller Units (MCU)}{MCUs} \li \l{MCUs}
\li \image ok.png \li \image ok.png
\li \li
\li \image ok.png \li \image ok.png
@@ -62,6 +57,11 @@
\li \image ok.png \li \image ok.png
\li \image ok.png \li \image ok.png
\li \inlineimage ok.png \li \inlineimage ok.png
\row
\li \l{Remote Linux}
\li \image ok.png
\li \image ok.png
\li \image ok.png
\row \row
\li \l{Building Applications for the Web}{WebAssembly} \li \l{Building Applications for the Web}{WebAssembly}
\li \image ok.png \li \image ok.png
@@ -74,5 +74,6 @@
\QC automatically runs scheduled checks for updates based on the settings \QC automatically runs scheduled checks for updates based on the settings
specified in \preferences > \uicontrol Environment > \uicontrol Update. specified in \preferences > \uicontrol Environment > \uicontrol Update.
\sa {Desktop Platforms}, {Embedded Platforms}, {Mobile Platforms} \sa {Develop for Devices}{How To: Develop for Devices}, {Desktop Platforms},
{Devices}
*/ */

6
doc/qtcreator/src/projects/creator-only/creator-projects-kits.qdoc
View File

@@ -31,9 +31,9 @@
\li \l{Adding Docker Devices}{Docker} (experimental) \li \l{Adding Docker Devices}{Docker} (experimental)
\li \l{Developing for iOS}{iOS} \li \l{Developing for iOS}{iOS}
\li iOS Simulator \li iOS Simulator
\li \l{Connecting MCUs}{MCU} (commercial only) \li \l{Developing for MCUs}{MCU} (commercial only)
\li \l{Connecting QNX Devices}{QNX} \li \l{Connecting QNX Devices}{QNX}
\li \l{Connecting Remote Linux Devices}{Remote Linux} \li \l{Developing for Remote Linux Devices}{Remote Linux}
\li \l{Building Applications for the Web}{WebAssembly Runtime} \li \l{Building Applications for the Web}{WebAssembly Runtime}
\endlist \endlist
@@ -72,7 +72,7 @@
\title Kits \title Kits
\brief Set kit preferences. A kit consists of a set of values that define \brief Set kit preferences. A kit consists of a set of values that define
one environment, such as a \e {device}, tool chain, Qt version, and debugger one environment, such as a \e {device}, toolchain, Qt version, and debugger
command to use. command to use.
Typically, only a subset of the kit preferences is relevant for a particular Typically, only a subset of the kit preferences is relevant for a particular

2
doc/qtcreator/src/projects/creator-only/creator-projects-settings-build.qdoc
View File

@@ -56,7 +56,7 @@
\section1 Build on remote devices \section1 Build on remote devices
You can build applications on \l{Connecting Remote Linux Devices} You can build applications on \l{Developing for Remote Linux Devices}
{remote Linux} or \l{Adding Docker Devices}{Docker} devices if you {remote Linux} or \l{Adding Docker Devices}{Docker} devices if you
have kits that specify the devices and toolchains to use. When the have kits that specify the devices and toolchains to use. When the
build device of the kit is a remote device, such as a remote Linux or build device of the kit is a remote device, such as a remote Linux or

4
doc/qtcreator/src/qnx/creator-developing-qnx.qdoc
View File

@@ -17,8 +17,8 @@
\section1 Adding a QNX Neutrino Device in \QC \section1 Adding a QNX Neutrino Device in \QC
Adding a QNX Neutrino device is very similar to Adding a QNX Neutrino device is very similar to adding a
\l{Connecting Remote Linux Devices}, except that \l{Add remote Linux devices}{remote Linux device}, except that
you need to select \uicontrol {QNX Device} in the you need to select \uicontrol {QNX Device} in the
\uicontrol {Device Configuration} wizard. \uicontrol {Device Configuration} wizard.

3
doc/qtcreator/src/qtcreator-toc.qdoc
View File

@@ -27,7 +27,6 @@
\li \l{Connecting Boot2Qt Devices} \li \l{Connecting Boot2Qt Devices}
\li \l{Adding Docker Devices} \li \l{Adding Docker Devices}
\li \l{Connecting QNX Devices} \li \l{Connecting QNX Devices}
\li \l{Connecting Remote Linux Devices}
\li \l{Building Applications for the Web} \li \l{Building Applications for the Web}
\endlist \endlist
\li \l{Debugging} \li \l{Debugging}
@@ -61,6 +60,8 @@
\generatelist creator-how-to-ios \generatelist creator-how-to-ios
\li MCUs \li MCUs
\generatelist creator-how-to-mcu \generatelist creator-how-to-mcu
\li Remote Linux
\generatelist creator-how-to-remote-linux
\endlist \endlist
\li Edit Code \li Edit Code
\generatelist creator-how-to-edit \generatelist creator-how-to-edit