From d0efa4720873c6cad6c1bc3ab673fc8973484e5f Mon Sep 17 00:00:00 2001 From: Leena Miettinen Date: Wed, 15 Jan 2025 14:12:39 +0100 Subject: [PATCH] Doc: Update info about Kits preferences - Fix changed field names - Add missing fields (some added by plugins might still be missing) - Combine helps for related fields that were placed on the same line Task-number: QTCREATORBUG-32016 Change-Id: I9917bf25af2793d74b3e4775d1e39b015ba51bf8 Reviewed-by: Christian Kandeler --- doc/qtcreator/src/linux-mobile/b2qtdev.qdoc | 4 ++- ...tor-how-to-build-on-remote-devices.qdocinc | 5 +-- doc/qtcreator/src/linux-mobile/linuxdev.qdoc | 5 +-- .../creator-how-to-edit-qbs-profiles.qdoc | 4 +-- .../creator-only/creator-projects-kits.qdoc | 33 ++++++++++--------- 5 files changed, 29 insertions(+), 22 deletions(-) diff --git a/doc/qtcreator/src/linux-mobile/b2qtdev.qdoc b/doc/qtcreator/src/linux-mobile/b2qtdev.qdoc index 04dceb49160..83c74237787 100644 --- a/doc/qtcreator/src/linux-mobile/b2qtdev.qdoc +++ b/doc/qtcreator/src/linux-mobile/b2qtdev.qdoc @@ -68,7 +68,9 @@ \li Go to \preferences > \uicontrol Kits. \li Select \uicontrol Add to add a kit for building for the device. \li Select the Qt version, compiler, and device that you added above. - \li In \uicontrol {Run device type}, select \uicontrol {Boot2Qt Device}. + \li In \uicontrol {Run device}, select \uicontrol {Boot2Qt Device} in + \uicontrol {Type}, and then select the actual device to run on in + \uicontrol {Device}. \li To specify build settings: \list 1 \li Open a project for an application you want to develop for the 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 index 041ba3dde53..affd01fc93d 100644 --- 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 @@ -35,8 +35,9 @@ \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 In \uicontrol {Type} in \uicontrol {Run device} and + \uicontrol {Build device}, select \uicontrol {\1}. Select + the actual device to run and build on in \uicontrol {Device}. \li To specify build settings: diff --git a/doc/qtcreator/src/linux-mobile/linuxdev.qdoc b/doc/qtcreator/src/linux-mobile/linuxdev.qdoc index d92e9a82441..de804c8daa5 100644 --- a/doc/qtcreator/src/linux-mobile/linuxdev.qdoc +++ b/doc/qtcreator/src/linux-mobile/linuxdev.qdoc @@ -92,8 +92,9 @@ \li Select the Qt version, compiler, and device that you added above. - \li In \uicontrol {Run device type}, select - \uicontrol {Remote Linux Device}. + \li In \uicontrol {Run device}, select \uicontrol {Remote Linux Device} + in \uicontrol {Type}, and then select the actual device to run on in + \uicontrol {Device}. \li To specify build settings: diff --git a/doc/qtcreator/src/projects/creator-only/creator-how-to-edit-qbs-profiles.qdoc b/doc/qtcreator/src/projects/creator-only/creator-how-to-edit-qbs-profiles.qdoc index a5037be5b91..926f41dd613 100644 --- a/doc/qtcreator/src/projects/creator-only/creator-how-to-edit-qbs-profiles.qdoc +++ b/doc/qtcreator/src/projects/creator-only/creator-how-to-edit-qbs-profiles.qdoc @@ -23,8 +23,8 @@ \list 1 \li In \preferences > \uicontrol Kits, select - the kit, and then select \uicontrol Change next to the - \uicontrol {Additional Qbs Profile Settings} field to open the + the kit, and then select \uicontrol Change next to + \uicontrol {Qbs profile additions} to open the \uicontrol {Custom Properties} dialog. \image qtcreator-qbs-profile-settings.png "Custom Properties dialog" \li Double-click an empty cell in the \uicontrol Key column to specify diff --git a/doc/qtcreator/src/projects/creator-only/creator-projects-kits.qdoc b/doc/qtcreator/src/projects/creator-only/creator-projects-kits.qdoc index e3c6ac94e3b..9258374104b 100644 --- a/doc/qtcreator/src/projects/creator-only/creator-projects-kits.qdoc +++ b/doc/qtcreator/src/projects/creator-only/creator-projects-kits.qdoc @@ -115,20 +115,14 @@ \li Name for the kit to use as a part of directory names. This value is used for the \c CurrentKit:FileSystemName variable, which determines the name of the shadow build directory, for example. - \row - \li \uicontrol{Run device type} - \li Type of the run device. \row \li \uicontrol {Run device} - \li The device to run applications on. + \li \uicontrol {Type} is the type of the run device, and + \uicontrol {Device} is the device to run applications on. \row \li \uicontrol {Build device} - \li The device to build applications on. - - \row - \li \uicontrol Sysroot - \li Directory where the device image is located. If you are not - cross-compiling, leave this field empty. + \li \uicontrol {Type} is the type of the build device, and + \uicontrol {Device} is the device to build applications on. \row \li \uicontrol {Emulator skin} \li Skin to use for the \l {Emulator}{\B2Q Emulator Device}. @@ -171,6 +165,10 @@ For Android kits, the \uicontrol {Android GDB server} field will display the path to GDB server executable. + \row + \li \uicontrol Sysroot + \li Directory where the device image is located. If you are not + cross-compiling, leave this field empty. \row \li \uicontrol {Qt version} \li Qt version to use for building the project. You can add Qt versions @@ -181,12 +179,12 @@ variable for the qmake executable. It refers to the qmake executable it finds as \b{Qt in PATH} and selects it as the Qt version to use for the \uicontrol Desktop kit that is created by default. + + \uicontrol {mkspec} is the name of the mkspec configuration that + qmake uses. If you leave this field empty, qmake uses the default + mkspec of the selected Qt version. \row - \li \uicontrol {Qt mkspec} - \li Name of the mkspec configuration that qmake uses. If you leave this - field empty, it uses the default mkspec of the selected Qt version. - \row - \li \uicontrol {Additional Qbs profile settings} + \li \uicontrol {Qbs profile additions} \li Select \uicontrol Change to add settings to Qbs build profiles. For more information, see \l {Edit Qbs profiles}. \row @@ -206,6 +204,11 @@ \li \uicontrol {CMake configuration} \li Select \uicontrol Change to edit the parameters of the CMake configuration for the kit. + \row + \li \uicontrol {Python} + \li Select the Python version for the kit. Select \uicontrol Manage + to add Python versions. For more information, see + \l{Select the Python version}. \row \li \uicontrol {Meson tool} \li Meson tool to use for building the project. Select \uicontrol Manage