Doc: Update docs for Docker devices

Task-number: QTCREATORBUG-28721
Change-Id: Ie00e736a0a7d8d3d7c6238ce74e1d516bb5dca1a
Reviewed-by: Marcus Tillmanns <marcus.tillmanns@qt.io>
This commit is contained in:
Leena Miettinen
2023-03-20 14:32:06 +01:00
parent 14292e74d2
commit cf1854a2d7
5 changed files with 44 additions and 20 deletions

View File

@@ -209,6 +209,7 @@ Platforms
* Added support for loading and attaching to core dumps from remote devices * Added support for loading and attaching to core dumps from remote devices
* Added support for using ClangFormat on remote files * Added support for using ClangFormat on remote files
* Added an option to enable necessary capabilities for debugging with LLDB * Added an option to enable necessary capabilities for debugging with LLDB
to `Edit > Preferences > Devices` for a Docker device
* Fixed an issue with space in file paths (QTCREATORBUG-28476) * Fixed an issue with space in file paths (QTCREATORBUG-28476)
* Fixed that auto-detection controls were shown for devices registered by the * Fixed that auto-detection controls were shown for devices registered by the
installer installer

Binary file not shown.

After

Width:  |  Height:  |  Size: 26 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 30 KiB

View File

@@ -1,4 +1,4 @@
// Copyright (C) 2022 The Qt Company Ltd. // Copyright (C) 2023 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
/*! /*!
@@ -25,11 +25,9 @@
{debuggers} and \l{Adding Qt Versions}{Qt versions}, in the Docker container {debuggers} and \l{Adding Qt Versions}{Qt versions}, in the Docker container
and creates kits for the devices. and creates kits for the devices.
You can use images that are available locally. You can pull To pull images from Docker hub or other registries, use the
images from Docker hub or other registries using the
\l{https://docs.docker.com/engine/reference/commandline/pull/}{docker pull} \l{https://docs.docker.com/engine/reference/commandline/pull/}{docker pull}
command. To check that an image is available locally, run the command.
\c {docker images} command in a terminal.
\section1 Enabling Docker Plugin \section1 Enabling Docker Plugin
@@ -54,22 +52,46 @@
\uicontrol {Docker Device} > \uicontrol {Start Wizard} \uicontrol {Docker Device} > \uicontrol {Start Wizard}
to search for images in your local Docker installation. to search for images in your local Docker installation.
\li Select the Docker image to use, and then select \uicontrol OK. \li Select the Docker image to use, and then select \uicontrol OK.
\li In \uicontrol Devices, check and modify Docker device preferences. \li In \uicontrol Devices, check and change Docker device preferences.
\image qtcreator-preferences-devices-docker-device.webp "Docker device preferences" \image qtcreator-preferences-devices-docker-device.png "Docker device preferences"
\li Select \uicontrol {Run as outside user} to use the user ID
and group ID of the user running \QC in the Docker container.
\li Select \uicontrol {Do not modify entry point} to stop \QC from
modifying the entry point of the image if the image starts into
a shell.
\li In \uicontrol {Paths to mount}, specify host directories to
mount into the container, such as the project directory.
\li In \uicontrol {Search locations}, select where to search
for kit items.
\li Select \uicontrol {Auto-detect Kit Items} to find kit items and to
create kits for the Docker device.
\li Select \uicontrol Apply to save your changes. \li Select \uicontrol Apply to save your changes.
\endlist \endlist
The following table summarizes the options you can set.
\table
\header
\li Option
\li Value
\row
\li \uicontrol {Run as outside user}
\li On Linux and \macos, sets the user ID and group ID of the user
running \QC in the Docker container. This option is not available
on Windows.
\row
\li \uicontrol {Do not modify entry point}
\li Stops \QC from modifying the \l {Modifying Entry Points}{entry point}
of the image. Make sure that the entry point starts a shell.
\row
\li \uicontrol {Enable flags needed for LLDB}
\li Adds the following flags to the container to allow LLDB to run:
\badcode
--cap-add=SYS_PTRACE --security-opt seccomp=unconfined
\endcode
\row
\li \uicontrol {Clangd executable}
\li The path to a remote Clangd executable to use for a remote code
model.
\row
\li \uicontrol {Paths to mount}
\li Host directories to \l{Specifying Paths to Mount}{mount} into the
container, such as the project directory.
\row
\li \uicontrol {Search locations}
\li Where to \l{Auto-detecting Kit Items}{automatically detect} kit
items.
\endtable
The following sections describe the Docker device preferences in more detail. The following sections describe the Docker device preferences in more detail.
\section2 Selecting Docker Images \section2 Selecting Docker Images

View File

@@ -1,4 +1,4 @@
// Copyright (C) 2022 The Qt Company Ltd. // Copyright (C) 2023 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
// ********************************************************************** // **********************************************************************
@@ -30,11 +30,12 @@
\li \l{https://doc.qt.io/Boot2Qt/b2qt-installation-guides.html} \li \l{https://doc.qt.io/Boot2Qt/b2qt-installation-guides.html}
{Boot2Qt Device} (commercial only) {Boot2Qt Device} (commercial only)
\li \l{Emulator}{Boot2Qt Emulator Device} (commercial only) \li \l{Emulator}{Boot2Qt Emulator Device} (commercial only)
\li \l{Connecting Remote Linux Devices}{Remote Linux Device} \li \l{Adding Docker Devices}{Docker Device} (experimental)
\li \l{Connecting iOS Devices}{iOS Device} \li \l{Connecting iOS Devices}{iOS Device}
\li iOS Simulator \li iOS Simulator
\li \l{Connecting MCUs}{MCU Device} (commercial only) \li \l{Connecting MCUs}{MCU Device} (commercial only)
\li \l{Connecting QNX Devices}{QNX Device} \li \l{Connecting QNX Devices}{QNX Device}
\li \l{Connecting Remote Linux Devices}{Remote Linux Device}
\li \l{Building Applications for the Web}{WebAssembly Runtime} \li \l{Building Applications for the Web}{WebAssembly Runtime}
\endlist \endlist