diff --git a/doc/qtcreator/images/creator-compilers-custom.png b/doc/qtcreator/images/creator-compilers-custom.png deleted file mode 100644 index d090b832593..00000000000 Binary files a/doc/qtcreator/images/creator-compilers-custom.png and /dev/null differ diff --git a/doc/qtcreator/images/qtcreator-preferences-compilers-clang-cl.webp b/doc/qtcreator/images/qtcreator-preferences-compilers-clang-cl.webp index c02517d1b21..f77fd47e0fc 100644 Binary files a/doc/qtcreator/images/qtcreator-preferences-compilers-clang-cl.webp and b/doc/qtcreator/images/qtcreator-preferences-compilers-clang-cl.webp differ diff --git a/doc/qtcreator/images/qtcreator-preferences-compilers-clang.webp b/doc/qtcreator/images/qtcreator-preferences-compilers-clang.webp index 68e3252355e..94745a8309a 100644 Binary files a/doc/qtcreator/images/qtcreator-preferences-compilers-clang.webp and b/doc/qtcreator/images/qtcreator-preferences-compilers-clang.webp differ diff --git a/doc/qtcreator/images/qtcreator-preferences-compilers-custom.webp b/doc/qtcreator/images/qtcreator-preferences-compilers-custom.webp new file mode 100644 index 00000000000..fc1c2b437c1 Binary files /dev/null and b/doc/qtcreator/images/qtcreator-preferences-compilers-custom.webp differ diff --git a/doc/qtcreator/images/qtcreator-preferences-compilers-qcc.webp b/doc/qtcreator/images/qtcreator-preferences-compilers-qcc.webp index 7d39d268a92..44b6e22e4a7 100644 Binary files a/doc/qtcreator/images/qtcreator-preferences-compilers-qcc.webp and b/doc/qtcreator/images/qtcreator-preferences-compilers-qcc.webp differ diff --git a/doc/qtcreator/images/qtcreator-preferences-compilers.webp b/doc/qtcreator/images/qtcreator-preferences-compilers.webp index 3a31ea611c1..25052e42ee4 100644 Binary files a/doc/qtcreator/images/qtcreator-preferences-compilers.webp and b/doc/qtcreator/images/qtcreator-preferences-compilers.webp differ diff --git a/doc/qtcreator/src/cmake/creator-projects-cmake.qdoc b/doc/qtcreator/src/cmake/creator-projects-cmake.qdoc index 524163a2894..5d680fef4d3 100644 --- a/doc/qtcreator/src/cmake/creator-projects-cmake.qdoc +++ b/doc/qtcreator/src/cmake/creator-projects-cmake.qdoc @@ -165,8 +165,14 @@ \section2 Add or remove CMake tools To add a path to a CMake executable that \QC does not detect automatically, - and to specify settings for it, select \uicontrol Add. To make changes to - automatically detected installations, select \uicontrol Clone. + and to specify settings for it, select \uicontrol Add. + + To add a CMake executable on a remote Linux device or in Docker, select + \uicontrol Remote in the dropdown menu in \uicontrol Browse + (\uicontrol Choose on \macos) in the \uicontrol Path field. + + To make changes to automatically detected installations, select + \uicontrol Clone. To remove the selected CMake executable from the list, select \uicontrol Remove. @@ -186,7 +192,8 @@ \image qtcreator-kits-cmake.png {Kits preferences} - \sa {Build with CMake}{How To: Build with CMake}, + \sa {Build applications on remote Linux devices}, {Build on Docker devices}, + {Build with CMake}{How To: Build with CMake}, {Manage Kits}{How To: Manage Kits}, {CMake}, {Kits} */ diff --git a/doc/qtcreator/src/docker/creator-docker.qdoc b/doc/qtcreator/src/docker/creator-docker.qdoc index 90a44e67b10..95d7427236b 100644 --- a/doc/qtcreator/src/docker/creator-docker.qdoc +++ b/doc/qtcreator/src/docker/creator-docker.qdoc @@ -199,3 +199,22 @@ \sa {Enable and disable plugins}, {Docker}{How To: Develop for Docker}, {Manage Kits}{How To: Manage Kits} */ + +/*! + \page creator-how-to-build-on-docker.html + \previouspage creator-how-tos.html + + \ingroup creator-how-to-docker + + \title Build on Docker devices + + In addition to building applications \e {for} Docker, you can use the + toolchain in Docker to build the applications \e {in} Docker. + + \note Enable the Docker plugin to use it. + + \include linux-mobile/creator-how-to-build-on-remote-devices.qdocinc {build on remote devices} {Docker device} + + \sa {Add CMake tools}, {Enable and disable plugins}, + {Docker}{How To: Develop for Docker}, {Manage Kits}{How To: Manage Kits} +*/ diff --git a/doc/qtcreator/src/linux-mobile/creator-how-to-build-on-remote-devices.qdocinc b/doc/qtcreator/src/linux-mobile/creator-how-to-build-on-remote-devices.qdocinc new file mode 100644 index 00000000000..7e3df7a988b --- /dev/null +++ b/doc/qtcreator/src/linux-mobile/creator-how-to-build-on-remote-devices.qdocinc @@ -0,0 +1,60 @@ +// Copyright (C) 2024 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only + +//! [build on remote devices] + + To build applications on a \1: + + \list 1 + + \li Go to \preferences > \uicontrol Devices > \uicontrol Devices, and + then select \uicontrol Add to add a \1. + + \li Go to \uicontrol {Preferences} > \uicontrol CMake > + \uicontrol Tools, and then select \uicontrol Add. + + \li In \uicontrol Path, select \uicontrol Remote in the dropdown + menu in \uicontrol Browse (\uicontrol Choose on \macos) to + add the path to the CMake executable on the \1. + + \li Go to \uicontrol {Preferences} > \uicontrol Kits > + \uicontrol {Qt Versions}, and then press \key Shift and click the + \uicontrol Add button to add the Qt version on the \1. + + \li Go to \uicontrol {Preferences} > \uicontrol Kits > + \uicontrol Compilers, and then select the compiler + type in \uicontrol Add. + + \li In \uicontrol {C compiler path}, select \uicontrol Remote in the + dropdown menu in \uicontrol Browse (\uicontrol Choose on \macos) to + add the path to the compiler on the \1. + + \li Go to \uicontrol {Preferences} > \uicontrol Kits + to add a kit for building on the device. + + \li Select the device, CMake tool, Qt version, and compiler that you + added above. + + \li In \uicontrol {Run device type} and \uicontrol {Build device}, select + \uicontrol {\1}. + + \li To specify build settings: + + \list 1 + + \li Open a project for an application you want to develop for the + device. + + \li Select \uicontrol Projects > \uicontrol {Build & Run} to activate + the kit that you specified above. + + \endlist + + \li Select \uicontrol Run to specify run settings. Usually, you can use + the default settings. + + When you run the project, \QC deploys the application as specified by + the deploy steps. + + \endlist +//! [build on remote devices] diff --git a/doc/qtcreator/src/linux-mobile/linuxdev.qdoc b/doc/qtcreator/src/linux-mobile/linuxdev.qdoc index 311b68a48b8..d92e9a82441 100644 --- a/doc/qtcreator/src/linux-mobile/linuxdev.qdoc +++ b/doc/qtcreator/src/linux-mobile/linuxdev.qdoc @@ -75,16 +75,18 @@ \li Select \uicontrol Add to add the Qt version for embedded Linux. - \li Go to \preferences > \uicontrol Kits > \uicontrol Compilers. + \li Go to \uicontrol {Preferences} > \uicontrol Kits > + \uicontrol Compilers. \li Select \uicontrol Add to add the compiler for building the applications. - \li Go to \preferences > \uicontrol Devices > \uicontrol Devices. + \li Go to \uicontrol {Preferences} > \uicontrol Devices > + \uicontrol Devices. \li Select \uicontrol Add to add a remote Linux device. - \li Go to \preferences > \uicontrol Kits. + \li Go to \uicontrol {Preferences} > \uicontrol Kits. \li Select \uicontrol Add to add a kit for building for the device. @@ -150,56 +152,9 @@ In addition to building applications \e {for} a generic Linux device, you can use the toolchain on the device to build the applications \e {on} the device. - To build applications on a remote Linux device: - - \list 1 - - \li Go to \preferences > \uicontrol Devices > \uicontrol Devices, and - then select \uicontrol Add to add a remote Linux device. - - \li Go to \preferences > \uicontrol CMake > \uicontrol {CMake Tools}, and - then select \uicontrol Add to add the path to the CMake executable - on the remote Linux device. - - \li Go to \preferences > \uicontrol Kits > \uicontrol {Qt Versions}, - and then select \uicontrol Add to add the Qt version on the remote - Linux device - - \li Go to \preferences > \uicontrol Kits > \uicontrol Compilers, and - then select \uicontrol Add to add the the compiler on the remote - Linux device. - - \li Go to \preferences > \uicontrol Kits, and then select \uicontrol Add - to add a kit for building for the device. - - \li Select the device, CMake tool, Qt version, and compiler that you - added above. - - \li In \uicontrol {Run device type} and \uicontrol {Build device}, select - \uicontrol {Remote Linux Device}. - - \li To specify build settings: - - \list 1 - - \li Open a project for an application you want to develop for the - device. - - \li Select \uicontrol Projects > \uicontrol {Build & Run} to activate - the kit that you specified above. - - \endlist - - \li Select \uicontrol Run to specify run settings. Usually, you can use - the default settings. - - When you run the project, \QC deploys the application as specified by - the deploy steps. - - \endlist + \include creator-how-to-build-on-remote-devices.qdocinc {build on remote devices} {remote Linux device} \sa {Add CMake tools}, {Remote Linux}{How To: Develop for remote Linux}, {Manage Kits}{How To: Manage Kits}, {Developing for Remote Linux Devices}, {Remote Linux Deploy Configuration}, {Remote Linux Run Settings} */ - diff --git a/doc/qtcreator/src/projects/creator-only/creator-projects-compilers.qdoc b/doc/qtcreator/src/projects/creator-only/creator-projects-compilers.qdoc index f5d96cf5f2f..a7f459aec30 100644 --- a/doc/qtcreator/src/projects/creator-only/creator-projects-compilers.qdoc +++ b/doc/qtcreator/src/projects/creator-only/creator-projects-compilers.qdoc @@ -217,10 +217,16 @@ \li In \uicontrol {C compiler path}, enter the path to the directory where the C compiler is located. - \li In \uicontrol {C++ compiler path}, enter the path - to the directory where the C++ compiler is located. Select - \uicontrol {Derive from C compiler} to derive the C++ compiler - name from the C compiler name. + Select \uicontrol Remote in the dropdown menu in \uicontrol Browse + (\uicontrol Choose on \macos) to add the path to the compiler on a + remote Linux device or in Docker. + + \li In \uicontrol {C++ compiler path}, select + \uicontrol {Provide manually} to enter the path + to the directory where the C++ compiler is located. + + Select \uicontrol Remote to add the path to the compiler on a + remote Linux device or in Docker. \li In \uicontrol Initialization, select the \c {vcvarsall.bat} file for setting up the command @@ -274,20 +280,30 @@ \uicontrol Custom option. Specify the paths to the directories where the compiler and make tool are located and set preferences for the compiler. - \image creator-compilers-custom.png + \image qtcreator-preferences-compilers-custom.webp {Compilers in Kit Preferences} To add other compilers: \list 1 \li Select \preferences > \uicontrol Kits > - \uicontrol Compilers > \uicontrol Add > \uicontrol Custom > - \uicontrol C or \uicontrol C++. + \uicontrol Compilers > \uicontrol Add > \uicontrol Custom. \li In \uicontrol Name, enter a name for the compiler. - \li In \uicontrol {Compiler path}, enter the path to the directory - where the compiler is located. + \li In \uicontrol {C compiler path}, enter the path to the + directory where the C compiler is located. + + Select \uicontrol Remote in the dropdown menu in \uicontrol Browse + (\uicontrol Choose on \macos) to add the path to the compiler on a + remote Linux device or in Docker. + + \li In \uicontrol {C++ compiler path}, select + \uicontrol {Provide manually} to enter the path + to the directory where the C++ compiler is located. + + Select \uicontrol Remote to add the path to the compiler on a + remote Linux device or in Docker. \li In \uicontrol {Make path}, enter the path to the directory where the make tool is located. diff --git a/doc/qtcreator/src/projects/creator-only/creator-projects-qt-versions.qdoc b/doc/qtcreator/src/projects/creator-only/creator-projects-qt-versions.qdoc index a535c12b304..1e01dbad8aa 100644 --- a/doc/qtcreator/src/projects/creator-only/creator-projects-qt-versions.qdoc +++ b/doc/qtcreator/src/projects/creator-only/creator-projects-qt-versions.qdoc @@ -71,6 +71,9 @@ \li Select \preferences > \uicontrol Kits > \uicontrol {Qt Versions} > \uicontrol Add. + To add a Qt version on a remote Linux device or in Docker, + press \key Shift and click \uicontrol Add. + \li Select the qmake executable for the Qt version to add. \li Select the Qt version to view and edit it.