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>
This commit is contained in:
Leena Miettinen
2024-01-09 11:10:02 +01:00
parent cdb5514040
commit fa17c9b8fa
26 changed files with 40 additions and 33 deletions

View File

@@ -11,7 +11,7 @@
\brief Settings for running applications on Android devices. \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} > you select for a kit in \uicontrol Projects > \uicontrol {Build & Run} >
\uicontrol Run > \uicontrol {Run Settings}. \uicontrol Run > \uicontrol {Run Settings}.

View File

@@ -183,7 +183,7 @@
\image qtcreator-kits-cmake.png {Kits preferences} \image qtcreator-kits-cmake.png {Kits preferences}
\sa {CMake}, {Add kits}, {Kits} \sa {CMake}, {Add kits}, {kits-tab}{Kits}
*/ */
/*! /*!

View File

@@ -16,7 +16,7 @@
\title Setting Up Debugger \title Setting Up Debugger
The main debugger preferences are associated with the 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 specify the debugger and compiler to use for each kit, select
\preferences > \uicontrol Kits. \preferences > \uicontrol Kits.

View File

@@ -18,7 +18,7 @@
To build, run, and debug applications on Docker devices, you must install and To build, run, and debug applications on Docker devices, you must install and
configure \c docker-cli on the development host. \QC automatically detects 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 {debuggers} and \l{Add Qt versions}{Qt versions}, in the Docker container
and creates kits for the devices. and creates kits for the devices.

View File

@@ -41,7 +41,7 @@
instructions to install \QC. instructions to install \QC.
To develop with Qt, you also need a Qt version. You can register Qt versions 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 \section2 Use package managers

View File

@@ -18,7 +18,7 @@
To be able to run and debug applications on Boot2Qt devices, To be able to run and debug applications on Boot2Qt devices,
you must add devices and select them in the \QC you must add devices and select them in the \QC
\l{Kits}{kit}. \l{kits-tab}{kit}.
\section1 Enabling the Boot2Qt Plugin \section1 Enabling the Boot2Qt Plugin

View File

@@ -11,7 +11,7 @@
\brief Settings for running applications on Boot2Qt devices. \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} > you select for a kit in \uicontrol Projects > \uicontrol {Build & Run} >
\uicontrol Run > \uicontrol {Run Settings}. \uicontrol Run > \uicontrol {Run Settings}.
@@ -25,6 +25,6 @@
The run settings display the path to the executable file on the development The run settings display the path to the executable file on the development
host and on the device. 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} {Deploying to Boot2Qt}
*/ */

View File

@@ -37,6 +37,6 @@
Select the \uicontrol {Forward to local display} check box to show a remotely Select the \uicontrol {Forward to local display} check box to show a remotely
running X11 client on a local display. 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} {Connecting Remote Linux Devices}
*/ */

View File

@@ -54,7 +54,7 @@
\image qtcreator-kits-meson.png "Setting Meson executable in Kit preferences" \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 \section1 Editing Meson Build Descriptions

View File

@@ -45,6 +45,10 @@
\annotatedlist creator-reference-preferences-cpp \annotatedlist creator-reference-preferences-cpp
\section2 Kits
\annotatedlist creator-reference-preferences-kits
\section2 Text Editor \section2 Text Editor
Configure the text editor to suit your needs. Configure the text editor to suit your needs.

View File

@@ -39,5 +39,5 @@
To remove the selected property, select \uicontrol Remove. 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}
*/ */

View File

@@ -176,7 +176,7 @@
\page creator-preferences-kits-compilers.html \page creator-preferences-kits-compilers.html
\previouspage creator-reference.html \previouspage creator-reference.html
\ingroup creator-reference-preferences \ingroup creator-reference-preferences-kits
\title Compilers \title Compilers

View File

@@ -47,7 +47,7 @@
\li Select \uicontrol Add to start from an empty kit or \uicontrol Clone \li Select \uicontrol Add to start from an empty kit or \uicontrol Clone
to clone the selected kit and edit its preferences. to clone the selected kit and edit its preferences.
\image qtcreator-kits.png \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. device type.
\li Select \uicontrol OK to create the kit. \li Select \uicontrol OK to create the kit.
@@ -61,18 +61,19 @@
select \uicontrol {Make Default}. select \uicontrol {Make Default}.
\sa {Activate kits for a project}, {Add debuggers}, {Add Qt versions}, \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 \page creator-preferences-kits.html
\previouspage creator-reference.html \previouspage creator-reference.html
\ingroup creator-reference-preferences \ingroup creator-reference-preferences-kits
\target kits-tab
\title Kits \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 one environment, such as a \e {device}, tool chain, Qt version, and debugger
command to use. command to use.

View File

@@ -112,5 +112,5 @@
later. Select the \inlineimage icons/pin.png later. Select the \inlineimage icons/pin.png
(\uicontrol Pin) button to pin the progress bar back to the toggle button. (\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},
*/ */

View File

@@ -130,6 +130,6 @@
If your Qt version has no \c libQtCore.so, \QC cannot detect the ABI. If your Qt version has no \c libQtCore.so, \QC cannot detect the ABI.
\sa {Kits} \sa {kits-tab}{Kits}
*/ */

View File

@@ -63,7 +63,7 @@
\section1 Specifying Run Settings \section1 Specifying Run Settings
The run settings to specify depend on the type of the project and on the 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. \QC automatically creates deploy and run configurations for your project.
@@ -147,5 +147,5 @@
To import an existing build for the project, select To import an existing build for the project, select
\uicontrol {Import Existing Build}. \uicontrol {Import Existing Build}.
\sa {Add kits}, {Configuring Projects}, {Kits} \sa {Add kits}, {Configuring Projects}, {kits-tab}{Kits}
*/ */

View File

@@ -9,7 +9,7 @@
\title Specify Valgrind settings for a project \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} > you select for a kit in \uicontrol Projects > \uicontrol {Build & Run} >
\uicontrol Run > \uicontrol {Run Settings}. \uicontrol Run > \uicontrol {Run Settings}.

View File

@@ -10,7 +10,7 @@
\title Enable debugging \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} > you select for a kit in \uicontrol Projects > \uicontrol {Build & Run} >
\uicontrol Run > \uicontrol {Run Settings}. \uicontrol Run > \uicontrol {Run Settings}.

View File

@@ -11,7 +11,7 @@
\brief Settings for running applications on desktop device types. \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} > you select for a kit in \uicontrol Projects > \uicontrol {Build & Run} >
\uicontrol Run > \uicontrol {Run Settings}. \uicontrol Run > \uicontrol {Run Settings}.

View File

@@ -16,7 +16,7 @@
\title Configure projects for running \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} > you select for a kit in \uicontrol Projects > \uicontrol {Build & Run} >
\uicontrol Run > \uicontrol {Run Settings}. \uicontrol Run > \uicontrol {Run Settings}.

View File

@@ -31,7 +31,7 @@
\brief Settings for running Qt for Python applications. \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} > you select for a kit in \uicontrol Projects > \uicontrol {Build & Run} >
\uicontrol Run > \uicontrol {Run Settings}. \uicontrol Run > \uicontrol {Run Settings}.

View File

@@ -11,7 +11,7 @@
\brief Settings for running applications on Linux-based devices. \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} > you select for a kit in \uicontrol Projects > \uicontrol {Build & Run} >
\uicontrol Run > \uicontrol {Run Settings}. \uicontrol Run > \uicontrol {Run Settings}.
@@ -23,5 +23,5 @@
devices. devices.
\sa {Remote Linux Run Settings}, {Activate kits for a project}, \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}
*/ */

View File

@@ -189,6 +189,8 @@
\generatelist creator-reference-preferences-analyzer \generatelist creator-reference-preferences-analyzer
\li C++ \li C++
\generatelist creator-reference-preferences-cpp \generatelist creator-reference-preferences-cpp
\li Kits
\generatelist creator-reference-preferences-kits
\li Text editor \li Text editor
\generatelist creator-reference-preferences-text-editor \generatelist creator-reference-preferences-text-editor
\endlist \endlist

View File

@@ -11,11 +11,11 @@
\brief Settings for running Qt Quick UI Prototype projects (.qmlproject). \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} > you select for a kit in \uicontrol Projects > \uicontrol {Build & Run} >
\uicontrol Run > \uicontrol {Run Settings}. \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. in the kit.
\image qtquick-ui-prototype-run-settings.webp {Run Settings for a Qt Quick UI Prototype project} \image qtquick-ui-prototype-run-settings.webp {Run Settings for a Qt Quick UI Prototype project}
@@ -42,5 +42,5 @@
\endtable \endtable
\sa {Create Qt Quick UI Prototypes}, {Activate kits for a project}, \sa {Create Qt Quick UI Prototypes}, {Activate kits for a project},
{Configure projects for running}, {Kits} {Configure projects for running}, {kits-tab}{Kits}
*/ */

View File

@@ -81,7 +81,7 @@
\note Kits are listed if they have been specified in \preferences > \note Kits are listed if they have been specified in \preferences >
\uicontrol Kits. \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} \li Select \uicontrol Next to open the \uicontrol {Project Management}
dialog. dialog.
@@ -167,7 +167,7 @@
\note Kits are listed if they have been specified in \preferences > \note Kits are listed if they have been specified in \preferences >
\uicontrol Kits. \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} \li Select \uicontrol Next to open the \uicontrol {Project Management}
dialog. dialog.

View File

@@ -44,7 +44,7 @@
\note The list shows kits that you specify in \preferences > \note The list shows kits that you specify in \preferences >
\uicontrol Kits. \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} \li Select \uicontrol Next to open the \uicontrol {Project Management}
dialog. dialog.