From fa17c9b8fac1e57029c9ecd31d7288593337e831 Mon Sep 17 00:00:00 2001 From: Leena Miettinen Date: Tue, 9 Jan 2024 11:10:02 +0100 Subject: [PATCH] Doc: List Kit preferences under Preferences > Kits Add "\target kits-tab" for the Kits tab docs because the links need to be unique. Task-number: QTCREATORBUG-29361 Change-Id: I76058c521a4e2c08f24ea2f03846bef6eac9716a Reviewed-by: Eike Ziller --- .../android/creator-projects-settings-run-android.qdoc | 2 +- doc/qtcreator/src/cmake/creator-projects-cmake.qdoc | 2 +- .../debugger/creator-only/creator-debugger-setup.qdoc | 2 +- doc/qtcreator/src/docker/creator-docker.qdoc | 2 +- .../src/howto/creator-only/creator-how-to-install.qdoc | 2 +- doc/qtcreator/src/linux-mobile/b2qtdev.qdoc | 2 +- .../linux-mobile/creator-projects-settings-run-b2qt.qdoc | 4 ++-- .../creator-projects-settings-run-linux.qdoc | 2 +- doc/qtcreator/src/meson/creator-projects-meson.qdoc | 2 +- .../src/overview/creator-only/creator-reference.qdoc | 4 ++++ .../creator-only/creator-how-to-edit-qbs-profiles.qdoc | 2 +- .../creator-only/creator-projects-compilers.qdoc | 2 +- .../src/projects/creator-only/creator-projects-kits.qdoc | 9 +++++---- .../projects/creator-only/creator-projects-opening.qdoc | 2 +- .../creator-only/creator-projects-qt-versions.qdoc | 2 +- .../creator-only/creator-projects-settings-overview.qdoc | 4 ++-- .../creator-projects-settings-run-analyze.qdoc | 2 +- .../creator-projects-settings-run-debug.qdoc | 2 +- .../creator-projects-settings-run-desktop.qdoc | 2 +- .../creator-only/creator-projects-settings-run.qdoc | 2 +- .../src/python/creator-python-run-settings.qdoc | 2 +- .../src/qnx/creator-projects-settings-run-qnx.qdoc | 4 ++-- doc/qtcreator/src/qtcreator-toc.qdoc | 2 ++ .../creator-projects-settings-run-qtquick.qdoc | 6 +++--- .../src/qtquick/creator-only/qtquick-creating.qdoc | 4 ++-- .../qtquick-tutorial-create-empty-project.qdocinc | 2 +- 26 files changed, 40 insertions(+), 33 deletions(-) diff --git a/doc/qtcreator/src/android/creator-projects-settings-run-android.qdoc b/doc/qtcreator/src/android/creator-projects-settings-run-android.qdoc index 6cde1d3537f..8904f697850 100644 --- a/doc/qtcreator/src/android/creator-projects-settings-run-android.qdoc +++ b/doc/qtcreator/src/android/creator-projects-settings-run-android.qdoc @@ -11,7 +11,7 @@ \brief Settings for running applications on Android devices. - Specify settings for running applications on the \l {Kits}{Run device} that + Specify settings for running applications on the \l {kits-tab}{Run device} that you select for a kit in \uicontrol Projects > \uicontrol {Build & Run} > \uicontrol Run > \uicontrol {Run Settings}. diff --git a/doc/qtcreator/src/cmake/creator-projects-cmake.qdoc b/doc/qtcreator/src/cmake/creator-projects-cmake.qdoc index 9bf9f100840..b38928e8439 100644 --- a/doc/qtcreator/src/cmake/creator-projects-cmake.qdoc +++ b/doc/qtcreator/src/cmake/creator-projects-cmake.qdoc @@ -183,7 +183,7 @@ \image qtcreator-kits-cmake.png {Kits preferences} - \sa {CMake}, {Add kits}, {Kits} + \sa {CMake}, {Add kits}, {kits-tab}{Kits} */ /*! diff --git a/doc/qtcreator/src/debugger/creator-only/creator-debugger-setup.qdoc b/doc/qtcreator/src/debugger/creator-only/creator-debugger-setup.qdoc index 39fd8013715..53780c96a5d 100644 --- a/doc/qtcreator/src/debugger/creator-only/creator-debugger-setup.qdoc +++ b/doc/qtcreator/src/debugger/creator-only/creator-debugger-setup.qdoc @@ -16,7 +16,7 @@ \title Setting Up Debugger The main debugger preferences are associated with the - \l{Kits}{kit} you build and run your project with. To + \l{kits-tab}{kit} you build and run your project with. To specify the debugger and compiler to use for each kit, select \preferences > \uicontrol Kits. diff --git a/doc/qtcreator/src/docker/creator-docker.qdoc b/doc/qtcreator/src/docker/creator-docker.qdoc index ae1dced8cea..15f147d475c 100644 --- a/doc/qtcreator/src/docker/creator-docker.qdoc +++ b/doc/qtcreator/src/docker/creator-docker.qdoc @@ -18,7 +18,7 @@ To build, run, and debug applications on Docker devices, you must install and configure \c docker-cli on the development host. \QC automatically detects - \l{Kits}{build and run kit} items, such \l{Add debuggers} + \l{kits-tab}{build and run kit} items, such \l{Add debuggers} {debuggers} and \l{Add Qt versions}{Qt versions}, in the Docker container and creates kits for the devices. diff --git a/doc/qtcreator/src/howto/creator-only/creator-how-to-install.qdoc b/doc/qtcreator/src/howto/creator-only/creator-how-to-install.qdoc index 356330b0ff6..d19c3e9d8fb 100644 --- a/doc/qtcreator/src/howto/creator-only/creator-how-to-install.qdoc +++ b/doc/qtcreator/src/howto/creator-only/creator-how-to-install.qdoc @@ -41,7 +41,7 @@ instructions to install \QC. To develop with Qt, you also need a Qt version. You can register Qt versions - in the stand-alone \QC to use them in \l{Kits}{kits}. + in the stand-alone \QC to use them in \l{kits-tab}{kits}. \section2 Use package managers diff --git a/doc/qtcreator/src/linux-mobile/b2qtdev.qdoc b/doc/qtcreator/src/linux-mobile/b2qtdev.qdoc index d21656bf72f..b1cc26e9297 100644 --- a/doc/qtcreator/src/linux-mobile/b2qtdev.qdoc +++ b/doc/qtcreator/src/linux-mobile/b2qtdev.qdoc @@ -18,7 +18,7 @@ To be able to run and debug applications on Boot2Qt devices, you must add devices and select them in the \QC - \l{Kits}{kit}. + \l{kits-tab}{kit}. \section1 Enabling the Boot2Qt Plugin diff --git a/doc/qtcreator/src/linux-mobile/creator-projects-settings-run-b2qt.qdoc b/doc/qtcreator/src/linux-mobile/creator-projects-settings-run-b2qt.qdoc index 6b94fd432cc..1391cfcfd48 100644 --- a/doc/qtcreator/src/linux-mobile/creator-projects-settings-run-b2qt.qdoc +++ b/doc/qtcreator/src/linux-mobile/creator-projects-settings-run-b2qt.qdoc @@ -11,7 +11,7 @@ \brief Settings for running applications on Boot2Qt devices. - Specify settings for running applications on the \l {Kits}{Run device} that + Specify settings for running applications on the \l {kits-tab}{Run device} that you select for a kit in \uicontrol Projects > \uicontrol {Build & Run} > \uicontrol Run > \uicontrol {Run Settings}. @@ -25,6 +25,6 @@ The run settings display the path to the executable file on the development host and on the device. - \sa {Activate kits for a project}, {Configure projects for running}, {Kits}, + \sa {Activate kits for a project}, {Configure projects for running}, {kits-tab}{Kits}, {Deploying to Boot2Qt} */ diff --git a/doc/qtcreator/src/linux-mobile/creator-projects-settings-run-linux.qdoc b/doc/qtcreator/src/linux-mobile/creator-projects-settings-run-linux.qdoc index 9294c9a920f..4e2a08e1326 100644 --- a/doc/qtcreator/src/linux-mobile/creator-projects-settings-run-linux.qdoc +++ b/doc/qtcreator/src/linux-mobile/creator-projects-settings-run-linux.qdoc @@ -37,6 +37,6 @@ Select the \uicontrol {Forward to local display} check box to show a remotely running X11 client on a local display. - \sa {Activate kits for a project}, {Configure projects for running}, {Kits}, + \sa {Activate kits for a project}, {Configure projects for running}, {kits-tab}{Kits}, {Connecting Remote Linux Devices} */ diff --git a/doc/qtcreator/src/meson/creator-projects-meson.qdoc b/doc/qtcreator/src/meson/creator-projects-meson.qdoc index 0c08edc2718..a6418fcc663 100644 --- a/doc/qtcreator/src/meson/creator-projects-meson.qdoc +++ b/doc/qtcreator/src/meson/creator-projects-meson.qdoc @@ -54,7 +54,7 @@ \image qtcreator-kits-meson.png "Setting Meson executable in Kit preferences" - For more information, see \l {Kits}. + For more information, see \l {kits-tab}{Kits}. \section1 Editing Meson Build Descriptions diff --git a/doc/qtcreator/src/overview/creator-only/creator-reference.qdoc b/doc/qtcreator/src/overview/creator-only/creator-reference.qdoc index ecf69768eb4..c6cf82627b2 100644 --- a/doc/qtcreator/src/overview/creator-only/creator-reference.qdoc +++ b/doc/qtcreator/src/overview/creator-only/creator-reference.qdoc @@ -45,6 +45,10 @@ \annotatedlist creator-reference-preferences-cpp + \section2 Kits + + \annotatedlist creator-reference-preferences-kits + \section2 Text Editor Configure the text editor to suit your needs. 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..60f0d3bb0b1 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 @@ -39,5 +39,5 @@ To remove the selected property, select \uicontrol Remove. - \sa {Activate kits for a project}, {Add kits}, {Kits} + \sa {Activate kits for a project}, {Add kits}, {kits-tab}{Kits} */ 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 6e0b789358b..d92e8c90a47 100644 --- a/doc/qtcreator/src/projects/creator-only/creator-projects-compilers.qdoc +++ b/doc/qtcreator/src/projects/creator-only/creator-projects-compilers.qdoc @@ -176,7 +176,7 @@ \page creator-preferences-kits-compilers.html \previouspage creator-reference.html - \ingroup creator-reference-preferences + \ingroup creator-reference-preferences-kits \title Compilers 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 dc0fe3abc42..d856f420c5e 100644 --- a/doc/qtcreator/src/projects/creator-only/creator-projects-kits.qdoc +++ b/doc/qtcreator/src/projects/creator-only/creator-projects-kits.qdoc @@ -47,7 +47,7 @@ \li Select \uicontrol Add to start from an empty kit or \uicontrol Clone to clone the selected kit and edit its preferences. \image qtcreator-kits.png - \li Set \l{Kits}{kit preferences} according to the build system and + \li Set \l{kits-tab}{kit preferences} according to the build system and device type. \li Select \uicontrol OK to create the kit. @@ -61,18 +61,19 @@ select \uicontrol {Make Default}. \sa {Activate kits for a project}, {Add debuggers}, {Add Qt versions}, - {Open projects}, {Compilers}, {Kits} + {Open projects}, {Compilers}, {kits-tab}{Kits} */ /*! \page creator-preferences-kits.html \previouspage creator-reference.html - \ingroup creator-reference-preferences + \ingroup creator-reference-preferences-kits + \target kits-tab \title Kits - \brief Sets 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 command to use. diff --git a/doc/qtcreator/src/projects/creator-only/creator-projects-opening.qdoc b/doc/qtcreator/src/projects/creator-only/creator-projects-opening.qdoc index 7fe0105c1c5..2b0a47ac798 100644 --- a/doc/qtcreator/src/projects/creator-only/creator-projects-opening.qdoc +++ b/doc/qtcreator/src/projects/creator-only/creator-projects-opening.qdoc @@ -112,5 +112,5 @@ later. Select the \inlineimage icons/pin.png (\uicontrol Pin) button to pin the progress bar back to the toggle button. - \sa {Activate kits for a project}, {Add kits}, {Kits}, + \sa {Activate kits for a project}, {Add kits}, {kits-tab}{Kits}, */ 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 63090c65c87..0b06e1d84c1 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 @@ -130,6 +130,6 @@ If your Qt version has no \c libQtCore.so, \QC cannot detect the ABI. - \sa {Kits} + \sa {kits-tab}{Kits} */ diff --git a/doc/qtcreator/src/projects/creator-only/creator-projects-settings-overview.qdoc b/doc/qtcreator/src/projects/creator-only/creator-projects-settings-overview.qdoc index 98706bdc0af..b016595e33b 100644 --- a/doc/qtcreator/src/projects/creator-only/creator-projects-settings-overview.qdoc +++ b/doc/qtcreator/src/projects/creator-only/creator-projects-settings-overview.qdoc @@ -63,7 +63,7 @@ \section1 Specifying Run Settings The run settings to specify depend on the type of the project and on the - \l{Kits}{Run device} that you select for the kit. + \l{kits-tab}{Run device} that you select for the kit. \QC automatically creates deploy and run configurations for your project. @@ -147,5 +147,5 @@ To import an existing build for the project, select \uicontrol {Import Existing Build}. - \sa {Add kits}, {Configuring Projects}, {Kits} + \sa {Add kits}, {Configuring Projects}, {kits-tab}{Kits} */ diff --git a/doc/qtcreator/src/projects/creator-only/creator-projects-settings-run-analyze.qdoc b/doc/qtcreator/src/projects/creator-only/creator-projects-settings-run-analyze.qdoc index 4f8188285f4..34233c90d83 100644 --- a/doc/qtcreator/src/projects/creator-only/creator-projects-settings-run-analyze.qdoc +++ b/doc/qtcreator/src/projects/creator-only/creator-projects-settings-run-analyze.qdoc @@ -9,7 +9,7 @@ \title Specify Valgrind settings for a project - Specify settings for running applications on the \l {Kits}{Run device} that + Specify settings for running applications on the \l {kits-tab}{Run device} that you select for a kit in \uicontrol Projects > \uicontrol {Build & Run} > \uicontrol Run > \uicontrol {Run Settings}. diff --git a/doc/qtcreator/src/projects/creator-only/creator-projects-settings-run-debug.qdoc b/doc/qtcreator/src/projects/creator-only/creator-projects-settings-run-debug.qdoc index 99c0decce96..770478d5b66 100644 --- a/doc/qtcreator/src/projects/creator-only/creator-projects-settings-run-debug.qdoc +++ b/doc/qtcreator/src/projects/creator-only/creator-projects-settings-run-debug.qdoc @@ -10,7 +10,7 @@ \title Enable debugging - Specify settings for running applications on the \l {Kits}{Run device} that + Specify settings for running applications on the \l {kits-tab}{Run device} that you select for a kit in \uicontrol Projects > \uicontrol {Build & Run} > \uicontrol Run > \uicontrol {Run Settings}. diff --git a/doc/qtcreator/src/projects/creator-only/creator-projects-settings-run-desktop.qdoc b/doc/qtcreator/src/projects/creator-only/creator-projects-settings-run-desktop.qdoc index 02dc0de2a4b..01458baf266 100644 --- a/doc/qtcreator/src/projects/creator-only/creator-projects-settings-run-desktop.qdoc +++ b/doc/qtcreator/src/projects/creator-only/creator-projects-settings-run-desktop.qdoc @@ -11,7 +11,7 @@ \brief Settings for running applications on desktop device types. - Specify settings for running applications on the \l {Kits}{Run device} that + Specify settings for running applications on the \l {kits-tab}{Run device} that you select for a kit in \uicontrol Projects > \uicontrol {Build & Run} > \uicontrol Run > \uicontrol {Run Settings}. 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 8075c09b9ea..7f8ba6894b8 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 @@ -16,7 +16,7 @@ \title Configure projects for running - Specify settings for running applications on the \l {Kits}{Run device} that + Specify settings for running applications on the \l {kits-tab}{Run device} that you select for a kit in \uicontrol Projects > \uicontrol {Build & Run} > \uicontrol Run > \uicontrol {Run Settings}. diff --git a/doc/qtcreator/src/python/creator-python-run-settings.qdoc b/doc/qtcreator/src/python/creator-python-run-settings.qdoc index af47114c45c..3d5d5eab27b 100644 --- a/doc/qtcreator/src/python/creator-python-run-settings.qdoc +++ b/doc/qtcreator/src/python/creator-python-run-settings.qdoc @@ -31,7 +31,7 @@ \brief Settings for running Qt for Python applications. - Specify settings for running applications on the \l {Kits}{Run device} that + Specify settings for running applications on the \l {kits-tab}{Run device} that you select for a kit in \uicontrol Projects > \uicontrol {Build & Run} > \uicontrol Run > \uicontrol {Run Settings}. diff --git a/doc/qtcreator/src/qnx/creator-projects-settings-run-qnx.qdoc b/doc/qtcreator/src/qnx/creator-projects-settings-run-qnx.qdoc index 568eca91e37..c3fd8861c07 100644 --- a/doc/qtcreator/src/qnx/creator-projects-settings-run-qnx.qdoc +++ b/doc/qtcreator/src/qnx/creator-projects-settings-run-qnx.qdoc @@ -11,7 +11,7 @@ \brief Settings for running applications on Linux-based devices. - Specify settings for running applications on the \l {Kits}{Run device} that + Specify settings for running applications on the \l {kits-tab}{Run device} that you select for a kit in \uicontrol Projects > \uicontrol {Build & Run} > \uicontrol Run > \uicontrol {Run Settings}. @@ -23,5 +23,5 @@ devices. \sa {Remote Linux Run Settings}, {Activate kits for a project}, - {Configure projects for running}, {Kits}, {Connecting QNX Devices} + {Configure projects for running}, {kits-tab}{Kits}, {Connecting QNX Devices} */ diff --git a/doc/qtcreator/src/qtcreator-toc.qdoc b/doc/qtcreator/src/qtcreator-toc.qdoc index 9bfc575567a..ee161a83c74 100644 --- a/doc/qtcreator/src/qtcreator-toc.qdoc +++ b/doc/qtcreator/src/qtcreator-toc.qdoc @@ -189,6 +189,8 @@ \generatelist creator-reference-preferences-analyzer \li C++ \generatelist creator-reference-preferences-cpp + \li Kits + \generatelist creator-reference-preferences-kits \li Text editor \generatelist creator-reference-preferences-text-editor \endlist diff --git a/doc/qtcreator/src/qtquick/creator-only/creator-projects-settings-run-qtquick.qdoc b/doc/qtcreator/src/qtquick/creator-only/creator-projects-settings-run-qtquick.qdoc index 1d7be468c7b..3f2ee989012 100644 --- a/doc/qtcreator/src/qtquick/creator-only/creator-projects-settings-run-qtquick.qdoc +++ b/doc/qtcreator/src/qtquick/creator-only/creator-projects-settings-run-qtquick.qdoc @@ -11,11 +11,11 @@ \brief Settings for running Qt Quick UI Prototype projects (.qmlproject). - Specify settings for running applications on the \l {Kits}{Run device} that + Specify settings for running applications on the \l {kits-tab}{Run device} that you select for a kit in \uicontrol Projects > \uicontrol {Build & Run} > \uicontrol Run > \uicontrol {Run Settings}. - \note Select the \uicontrol Desktop device type for the \l{Kits}{Run device} + \note Select the \uicontrol Desktop device type for the \l{kits-tab}{Run device} in the kit. \image qtquick-ui-prototype-run-settings.webp {Run Settings for a Qt Quick UI Prototype project} @@ -42,5 +42,5 @@ \endtable \sa {Create Qt Quick UI Prototypes}, {Activate kits for a project}, - {Configure projects for running}, {Kits} + {Configure projects for running}, {kits-tab}{Kits} */ diff --git a/doc/qtcreator/src/qtquick/creator-only/qtquick-creating.qdoc b/doc/qtcreator/src/qtquick/creator-only/qtquick-creating.qdoc index d9193a80f6e..0ff290f0d0d 100644 --- a/doc/qtcreator/src/qtquick/creator-only/qtquick-creating.qdoc +++ b/doc/qtcreator/src/qtquick/creator-only/qtquick-creating.qdoc @@ -81,7 +81,7 @@ \note Kits are listed if they have been specified in \preferences > \uicontrol Kits. - For more information, see \l {Add kits} and \l {Kits}. + For more information, see \l {Add kits} and \l {kits-tab}{Kits}. \li Select \uicontrol Next to open the \uicontrol {Project Management} dialog. @@ -167,7 +167,7 @@ \note Kits are listed if they have been specified in \preferences > \uicontrol Kits. - For more information, see \l {Add kits} and \l {Kits}. + For more information, see \l {Add kits} and \l {kits-tab}{Kits}. \li Select \uicontrol Next to open the \uicontrol {Project Management} dialog. diff --git a/doc/qtcreator/src/qtquick/creator-only/qtquick-tutorial-create-empty-project.qdocinc b/doc/qtcreator/src/qtquick/creator-only/qtquick-tutorial-create-empty-project.qdocinc index 21029e29a3a..be0c55516a9 100644 --- a/doc/qtcreator/src/qtquick/creator-only/qtquick-tutorial-create-empty-project.qdocinc +++ b/doc/qtcreator/src/qtquick/creator-only/qtquick-tutorial-create-empty-project.qdocinc @@ -44,7 +44,7 @@ \note The list shows kits that you specify in \preferences > \uicontrol Kits. - For more information, see \l {Add kits} and \l {Kits}. + For more information, see \l {Add kits} and \l {kits-tab}{Kits}. \li Select \uicontrol Next to open the \uicontrol {Project Management} dialog.