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 <eike.ziller@qt.io>
2024-01-09 11:10:02 +01:00
parent cdb5514040
commit fa17c9b8fa
26 changed files with 40 additions and 33 deletions
--- 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}.

--- 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}
 */

 /*!
--- 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.

--- 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.

--- 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

--- 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

--- 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}
 */
--- 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}
 */
--- 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

--- 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.
--- 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}
 */
--- 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

--- 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.

--- 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},
 */
--- 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}
 */

--- 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}
 */
--- 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}.

--- 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}.

--- 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}.

--- 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}.

--- 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}.

--- 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}
 */
--- 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
--- 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}
 */
--- 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.
--- 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.