Doc: Fix the path to the Kits options

Kits is now a top-level category in Options, with tabs for
Kits, Qt Versions, Compilers, Debuggers, Qbs, and CMake.

Change-Id: I7f3b37550d47dadb76cb3454cdd4bd0b115eb986
Reviewed-by: hjk <hjk@qt.io>
This commit is contained in:
Leena Miettinen
2018-04-25 13:00:53 +02:00
parent 786cb9fb6f
commit b252043d44
17 changed files with 57 additions and 59 deletions

View File

@@ -90,9 +90,9 @@
\endlist \endlist
\li Select \uicontrol Tools > \uicontrol Options > \li Select \uicontrol Tools > \uicontrol Options > \uicontrol Kits >
\uicontrol {Build & Run} > \uicontrol Kits > \uicontrol Add to add a \uicontrol Add to add a kit for building applications and running
kit for building applications and running them on bare metal devices: them on bare metal devices:
\image creator-baremetal-kits.png "Bare Metal Device kits" \image creator-baremetal-kits.png "Bare Metal Device kits"

View File

@@ -62,8 +62,8 @@
\list 1 \list 1
\li Select \uicontrol Tools > \uicontrol Options > \li Select \uicontrol Tools > \uicontrol Options > \uicontrol Kits >
\uicontrol {Build & Run} > \uicontrol CMake > \uicontrol Add. \uicontrol CMake > \uicontrol Add.
\image qtcreator-cmakeexecutable.png \image qtcreator-cmakeexecutable.png

View File

@@ -41,8 +41,7 @@
The main debugger settings are associated with the The main debugger settings are associated with the
\l{glossary-buildandrun-kit}{kit} you build and run your project with. To \l{glossary-buildandrun-kit}{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
\uicontrol Tools > \uicontrol Options > \uicontrol {Build and Run} > \uicontrol Tools > \uicontrol Options > \uicontrol Kits.
\uicontrol Kits.
You need to set up the debugger only if the automatic setup fails, because You need to set up the debugger only if the automatic setup fails, because
the native debugger is missing (as is usually the case for the CDB debugger the native debugger is missing (as is usually the case for the CDB debugger
@@ -57,7 +56,7 @@
kit for your project. kit for your project.
If the debugger you want to use is not automatically detected, select If the debugger you want to use is not automatically detected, select
\uicontrol Tools > \uicontrol Options > \uicontrol {Build & Run} > \uicontrol Tools > \uicontrol Options > \uicontrol Kits >
\uicontrol Debuggers > \uicontrol Add to add it. \uicontrol Debuggers > \uicontrol Add to add it.
\note To use the debugging tools for Windows, you must install them and add \note To use the debugging tools for Windows, you must install them and add
@@ -330,7 +329,7 @@
\endcode \endcode
\li In \QC, select \uicontrol {Qt Creator} > \uicontrol Preferences > \li In \QC, select \uicontrol {Qt Creator} > \uicontrol Preferences >
\uicontrol {Build & Run} > \uicontrol Kits > \uicontrol Add to \uicontrol Kits > \uicontrol Add to
create a kit that uses FSF GDB. create a kit that uses FSF GDB.
\li In the \uicontrol Debugger field, specify the path to FSF GDB \li In the \uicontrol Debugger field, specify the path to FSF GDB
@@ -350,14 +349,14 @@
\list 1 \list 1
\li Select \uicontrol Tools > \uicontrol Options > \li Select \uicontrol Tools > \uicontrol Options >
\uicontrol {Build & Run} > \uicontrol Kits. \uicontrol Kits.
\li Select an automatically created kit in the list, and then select \li Select an automatically created kit in the list, and then select
\uicontrol Clone to create a copy of the kit. \uicontrol Clone to create a copy of the kit.
\li In the \uicontrol Debugger field, select an LLDB Engine. If an LLDB \li In the \uicontrol Debugger field, select an LLDB Engine. If an LLDB
Engine is not listed, select \uicontrol Manage to add it in Engine is not listed, select \uicontrol Manage to add it in
\uicontrol Tools > \uicontrol Options > \uicontrol {Build & Run} > \uicontrol Tools > \uicontrol Options > \uicontrol Kits >
\uicontrol Debuggers. For more information, see \uicontrol Debuggers. For more information, see
\l {Adding Debuggers}. \l {Adding Debuggers}.

View File

@@ -60,13 +60,13 @@
\li Make sure that your device can be reached via an IP address. \li Make sure that your device can be reached via an IP address.
\li Select \uicontrol {Tools > Options > Build & Run > Qt Versions > Add} to \li Select \uicontrol Tools > \uicontrol Options > \uicontrol Kits >
add the Qt version \uicontrol {Qt Versions} > \uicontrol Add to add the Qt version
for the embedded Linux. for embedded Linux.
\li Select \uicontrol {Tools > Options > Build & Run > Compilers > Add} to \li Select \uicontrol Tools > \uicontrol Options > \uicontrol Kits >
add the compiler \uicontrol Compilers > \uicontrol Add to add the compiler for
for building the applications. building the applications.
\li To deploy applications and run them remotely on devices, specify \li To deploy applications and run them remotely on devices, specify
parameters for accessing the devices: parameters for accessing the devices:
@@ -106,9 +106,8 @@
the SSH port number, which is available in the variable \c %{Device:SshPort}. the SSH port number, which is available in the variable \c %{Device:SshPort}.
\li Select \uicontrol Tools > \uicontrol Options > \uicontrol {Build & Run} \li Select \uicontrol Tools > \uicontrol Options > \uicontrol Kits >
> \uicontrol Kits > \uicontrol Add to add a kit for building for the device. \uicontrol Add to add a kit for building for the device. Select the
Select the
Qt version, compiler, and device that you added above, and choose Qt version, compiler, and device that you added above, and choose
\uicontrol {Generic Linux Device} for the device type. \uicontrol {Generic Linux Device} for the device type.

View File

@@ -68,7 +68,7 @@
yourself to tell \QC where everything is. yourself to tell \QC where everything is.
To add kits, select \uicontrol Tools > \uicontrol Options > To add kits, select \uicontrol Tools > \uicontrol Options >
\uicontrol {Build & Run} > \uicontrol Kits > \uicontrol Add. \uicontrol Kits > \uicontrol Add.
For more information, see \l{Adding Kits}. For more information, see \l{Adding Kits}.
@@ -76,12 +76,12 @@
\l{glossary-device}{device}, compiler, and Qt version. If you know you have \l{glossary-device}{device}, compiler, and Qt version. If you know you have
installed a Qt installed a Qt
version, but it is not listed in \uicontrol Tools > \uicontrol Options > version, but it is not listed in \uicontrol Tools > \uicontrol Options >
\uicontrol {Build & Run} > \uicontrol {Qt Versions}, you must add it. \uicontrol Kits > \uicontrol {Qt Versions}, you must add it.
For more information, see \l{Adding Qt Versions}. For more information, see \l{Adding Qt Versions}.
Also check that your compiler is listed in \uicontrol Tools > Also check that your compiler is listed in \uicontrol Tools >
\uicontrol Options > \uicontrol {Build & Run} > \uicontrol {Compilers}. \uicontrol Options > \uicontrol Kits > \uicontrol {Compilers}.
For more information, see \l{Adding Compilers}. For more information, see \l{Adding Compilers}.

View File

@@ -97,7 +97,7 @@
cross-platform development easier. Each kit consists of a set cross-platform development easier. Each kit consists of a set
of values that define one environment, such as a \l{glossary-device}{device}, of values that define one environment, such as a \l{glossary-device}{device},
tool chain, Qt version, and debugger command to use. Configure kits at tool chain, Qt version, and debugger command to use. Configure kits at
\uicontrol {Tools > Options > Build & Run > Kits}. \uicontrol Tools > \uicontrol Options > \uicontrol Kits.
\row \row
\li Mode \li Mode

View File

@@ -57,8 +57,9 @@
To change the location of the project directory, and to specify settings To change the location of the project directory, and to specify settings
for building and running projects, select \uicontrol Tools > for building and running projects, select \uicontrol Tools >
\uicontrol Options > \uicontrol {Build & Run} > \uicontrol General. The \uicontrol Options > \uicontrol {Build & Run} > \uicontrol General. The
\uicontrol CMake and \uicontrol Qbs tabs contain additional settings for \uicontrol CMake tab contains additional settings for CMake. You can find
those build systems. more settings for CMake and Qbs in \uicontrol Tools > \uicontrol Options >
\uicontrol Kits > \uicontrol CMake and \uicontrol Qbs.
To specify build and run settings for different target platforms, To specify build and run settings for different target platforms,
select \uicontrol Projects. For more information on the options you have, select \uicontrol Projects. For more information on the options you have,

View File

@@ -77,14 +77,14 @@
For QCC, also specify the path to the QNX Software Development Platform (SDP). For QCC, also specify the path to the QNX Software Development Platform (SDP).
You specify the compiler to use for each kit in \uicontrol Tools > You specify the compiler to use for each kit in \uicontrol Tools >
\uicontrol Options > \uicontrol {Build & Run} > \uicontrol Kits. \uicontrol Options > \uicontrol Kits.
To add C or C++ compilers: To add C or C++ compilers:
\list 1 \list 1
\li Select \uicontrol Tools > \uicontrol Options > \li Select \uicontrol Tools > \uicontrol Options >
\uicontrol {Build & Run} > \uicontrol Compilers > \uicontrol Add, \uicontrol Kits > \uicontrol Compilers > \uicontrol Add,
then select a compiler in the list, and then select \uicontrol C or then select a compiler in the list, and then select \uicontrol C or
\uicontrol C++ to add a C or C++ compiler. \uicontrol C++ to add a C or C++ compiler.
@@ -116,8 +116,8 @@
\section1 Adding Nim Compilers \section1 Adding Nim Compilers
To build an application using the Nim Compiler, select \uicontrol Tools > To build an application using the Nim Compiler, select \uicontrol Tools >
\uicontrol Options > \uicontrol {Build & Run} > \uicontrol Compilers > \uicontrol Options > \uicontrol Kits > \uicontrol Compilers >
\uicontrol Add > \uicontrol Nim, and specify the path to the directory where \uicontrol Add > \uicontrol Nim, and specify the path to the directory where
the compiler is located. the compiler is located.
@@ -133,7 +133,7 @@
\list 1 \list 1
\li Select \uicontrol Tools > \uicontrol Options > \uicontrol {Build & Run} > \li Select \uicontrol Tools > \uicontrol Options > \uicontrol Kits >
\uicontrol Compilers > \uicontrol Add > \uicontrol Custom > \uicontrol Compilers > \uicontrol Add > \uicontrol Custom >
\uicontrol C or \uicontrol C++. \uicontrol C or \uicontrol C++.

View File

@@ -45,13 +45,13 @@
The debugger plugin automatically selects a suitable native debugger for The debugger plugin automatically selects a suitable native debugger for
each \l{glossary-buildandrun-kit}{kit} from the ones found on your system. each \l{glossary-buildandrun-kit}{kit} from the ones found on your system.
To override this choice, select \uicontrol Tools > \uicontrol Options > To override this choice, select \uicontrol Tools > \uicontrol Options >
\uicontrol {Build & Run} > \uicontrol Kits. \uicontrol Kits.
To add debuggers: To add debuggers:
\list 1 \list 1
\li Select \uicontrol Tools > \uicontrol Options > \uicontrol {Build & Run} > \li Select \uicontrol Tools > \uicontrol Options > \uicontrol Kits >
\uicontrol Debuggers > \uicontrol Add. \uicontrol Debuggers > \uicontrol Add.
\image qtcreator-options-build-run-debuggers.png \image qtcreator-options-build-run-debuggers.png

View File

@@ -48,15 +48,15 @@
The \uicontrol {Configure Project} tab displays a list of \l{glossary-buildandrun-kit}{kits} The \uicontrol {Configure Project} tab displays a list of \l{glossary-buildandrun-kit}{kits}
for building and running projects, that are installed on the development PC and for building and running projects, that are installed on the development PC and
configured in \uicontrol Tools > \uicontrol Options > \uicontrol {Build & Run} > \uicontrol Kits. configured in \uicontrol Tools > \uicontrol Options > \uicontrol Kits.
Select the kits that you want to build and run the project with. Select the kits that you want to build and run the project with.
\image qtcreator-open-project-kits.png "Configure Project tab" \image qtcreator-open-project-kits.png "Configure Project tab"
Even if you do not intend to build the project, the C++ and QML code models Even if you do not intend to build the project, the C++ and QML code models
need a Qt version and compiler to offer code completion. To specify them, need a Qt version and compiler to offer code completion. To specify them,
select the \uicontrol Options link, or select \uicontrol {Tools > Options > Build & Run select the \uicontrol Options link, or select \uicontrol Tools >
> Kits}. \uicontrol Options > \uicontrol Kits.
If \QC cannot find an existing build for a particular \l{glossary-buildandrun-kit}{kit}, If \QC cannot find an existing build for a particular \l{glossary-buildandrun-kit}{kit},
it starts out it starts out

View File

@@ -41,7 +41,7 @@
kit. You can edit the build profiles by adding new keys and values. kit. You can edit the build profiles by adding new keys and values.
To check which Qbs version is being used, select \uicontrol Tools > To check which Qbs version is being used, select \uicontrol Tools >
\uicontrol Options > \uicontrol {Build & Run} > \uicontrol Qbs. \uicontrol Options > \uicontrol Kits > \uicontrol Qbs.
\section1 Building Qbs \section1 Building Qbs
@@ -60,7 +60,7 @@
\section1 Specifying Qbs Settings \section1 Specifying Qbs Settings
To specify settings for Qbs, select \uicontrol Tools > \uicontrol Options > To specify settings for Qbs, select \uicontrol Tools > \uicontrol Options >
\uicontrol {Build & Run} > \uicontrol Qbs. \uicontrol Kits > \uicontrol Qbs.
\image qtcreator-options-qbs.png \image qtcreator-options-qbs.png
@@ -73,7 +73,7 @@
In the \uicontrol Kit field, select a build and run kit to view the In the \uicontrol Kit field, select a build and run kit to view the
properties of the associated Qbs profile. To modify the properties of the properties of the associated Qbs profile. To modify the properties of the
Qbs profile associated with a kit, select \uicontrol Tools > Qbs profile associated with a kit, select \uicontrol Tools >
\uicontrol Options > \uicontrol {Build & Run} > \uicontrol Kits. For more \uicontrol Options > \uicontrol Kits. For more
information, see \l{Editing Qbs Profiles}. information, see \l{Editing Qbs Profiles}.
\section1 Related Topics \section1 Related Topics

View File

@@ -46,11 +46,12 @@
your system or by installers. To view detailed information for each Qt your system or by installers. To view detailed information for each Qt
version, select it in the list and select \uicontrol Details in the version, select it in the list and select \uicontrol Details in the
\uicontrol {Qt version for} section. To add Qt versions, select \uicontrol {Qt version for} section. To add Qt versions, select
\uicontrol {Tools > Options > Build & Run > Qt Versions}. \uicontrol Tools > \uicontrol Options > \uicontrol Kits >
\uicontrol {Qt Versions}.
You specify the Qt version to use for each \l{glossary-buildandrun-kit} You specify the Qt version to use for each \l{glossary-buildandrun-kit}
{kit} for building and running your projects {kit} for building and running your projects
in \uicontrol Tools > \uicontrol Options > \uicontrol {Build & Run} > \uicontrol Kits. in \uicontrol Tools > \uicontrol Options > \uicontrol Kits.
\section1 Setting Up New Qt Versions \section1 Setting Up New Qt Versions
@@ -58,7 +59,8 @@
\list 1 \list 1
\li Select \uicontrol {Tools > Options > Build & Run > Qt Versions > Add}. \li Select \uicontrol Tools > \uicontrol Options > \uicontrol Kits >
\uicontrol {Qt Versions} > \uicontrol Add.
\li Select the qmake executable for the Qt version that you want to \li Select the qmake executable for the Qt version that you want to
add. add.

View File

@@ -60,7 +60,7 @@
\image qtcreator-project-kits.png \image qtcreator-project-kits.png
The list displays kits that are configured in \uicontrol Tools > The list displays kits that are configured in \uicontrol Tools >
\uicontrol Options > \uicontrol {Build & Run} > \uicontrol Kits. To modify \uicontrol Options > \uicontrol Kits. To modify
kit configuration or to add kits to the list, right-click the sidebar to kit configuration or to add kits to the list, right-click the sidebar to
open a context-menu, and then select \uicontrol {Manage Kits}. For more open a context-menu, and then select \uicontrol {Manage Kits}. For more
information about managing kits, see \l{Adding Kits}. information about managing kits, see \l{Adding Kits}.

View File

@@ -67,8 +67,8 @@
\list 1 \list 1
\li Select \uicontrol Tools > \uicontrol Options > \uicontrol {Build & Run} \li Select \uicontrol Tools > \uicontrol Options > \uicontrol Kits >
> \uicontrol Kits > \uicontrol Add. \uicontrol Add.
\image qtcreator-kits.png \image qtcreator-kits.png
@@ -153,7 +153,7 @@
\section1 Editing Qbs Profiles \section1 Editing Qbs Profiles
To view the Qbs profile associated with the kit, select \uicontrol Tools > To view the Qbs profile associated with the kit, select \uicontrol Tools >
\uicontrol Options > \uicontrol {Build & Run} > \uicontrol Qbs. \uicontrol Options > \uicontrol Kits > \uicontrol Qbs.
You can add keys and values to the profile or remove them from it, as well You can add keys and values to the profile or remove them from it, as well
as modify existing values. For a list of available keys and values, see as modify existing values. For a list of available keys and values, see

View File

@@ -54,10 +54,9 @@
click \uicontrol{Next}. click \uicontrol{Next}.
\note Kits are listed if they have been specified in \uicontrol \note Kits are listed if they have been specified in \uicontrol
Tools > \uicontrol Options > \uicontrol {Build & Run} > Tools > \uicontrol Options > \uicontrol Kits (on Windows and Linux)
\uicontrol Kits (on Windows and Linux) or in \uicontrol {Qt Creator} or in \uicontrol {Qt Creator} > \uicontrol Preferences >
> \uicontrol Preferences \uicontrol {Build & Run} > \uicontrol Kits \uicontrol Kits (on \macos).
(on \macos).
\li Select \uicontrol Next. \li Select \uicontrol Next.

View File

@@ -130,8 +130,7 @@
your project, and then click \uicontrol Next. your project, and then click \uicontrol Next.
\note Kits are listed if they have been specified in \note Kits are listed if they have been specified in
\uicontrol Tools > \uicontrol Options > \uicontrol {Build & Run} > \uicontrol Tools > \uicontrol Options > \uicontrol Kits.
\uicontrol Kits.
\li Review the project settings, and click \uicontrol Finish (on Windows \li Review the project settings, and click \uicontrol Finish (on Windows
and Linux) or \uicontrol Done (on \macos) to create the project. and Linux) or \uicontrol Done (on \macos) to create the project.
@@ -173,10 +172,9 @@
click \uicontrol{Next}. click \uicontrol{Next}.
\note Kits are listed if they have been specified in \uicontrol \note Kits are listed if they have been specified in \uicontrol
Tools > \uicontrol Options > \uicontrol {Build & Run} > Tools > \uicontrol Options > \uicontrol Kits (on Windows and Linux)
\uicontrol Kits (on Windows and Linux) or in \uicontrol {Qt Creator} or in \uicontrol {Qt Creator} > \uicontrol Preferences >
> \uicontrol Preferences \uicontrol {Build & Run} > \uicontrol Kits \uicontrol Kits (on \macos).
(on \macos).
\li Select \uicontrol Next. \li Select \uicontrol Next.

View File

@@ -70,9 +70,9 @@
\li Select build and run \l{glossary-buildandrun-kit}{kits} for your project, \li Select build and run \l{glossary-buildandrun-kit}{kits} for your project,
and click \uicontrol Next or \uicontrol Continue. and click \uicontrol Next or \uicontrol Continue.
\note If only one kit is specified in \uicontrol Tools > \uicontrol Options > \note If only one kit is specified in \uicontrol Tools >
\uicontrol {Build & Run} > \uicontrol Kits (on Windows and Linux) or in \uicontrol Options > \uicontrol Kits (on Windows and Linux) or in
\uicontrol {Qt Creator} > \uicontrol Preferences \uicontrol {Build & Run} > \uicontrol Kits \uicontrol {Qt Creator} > \uicontrol Preferences > \uicontrol Kits
(on \macos), this dialog is skipped. (on \macos), this dialog is skipped.
The \uicontrol{Class Information} dialog opens. The \uicontrol{Class Information} dialog opens.