Doc: Turn "Activating Kits for a Project" into a how-to topic

Task-number: QTCREATORBUG-29361
Change-Id: I3545d29192176ba0a4377d77f51bc13155b46588
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
This commit is contained in:
Leena Miettinen
2023-09-08 16:17:54 +02:00
parent 2d9aa27b61
commit b7800d9351
7 changed files with 84 additions and 67 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.1 KiB

View File

@@ -35,7 +35,8 @@
virtual functions of base classes, create getter and setter functions, virtual functions of base classes, create getter and setter functions,
and generate constructors. You can specify settings for generating the and generate constructors. You can specify settings for generating the
functions either globally for all projects or separately for each project functions either globally for all projects or separately for each project
in the \l{Specifying Settings}{build and run} settings of the project. in the \l{Overriding Global Preferences}{build and run} settings of the
project.
\section2 Implementing Member Functions \section2 Implementing Member Functions

View File

@@ -44,22 +44,33 @@
\section1 Manage Projects \section1 Manage Projects
\list \table
\li \l {Add a license header template for C++ code} \header
\li \l {Add libraries to projects} \li Create Projects
\li \l {Add subprojects to projects} \li Configure Projects
\li \l {Add wizards} \row
\li \l {Create C++ classes} \li
\li \l {Create files} \list
\li \l {Create OpenGL fragment and vertex shaders} \li \l {Add a license header template for C++ code}
\li \l {Create resource files} \li \l {Add libraries to projects}
\li \l {Create VCS repositories for new projects} \li \l {Add subprojects to projects}
\li \l {Develop Qt for Python applications} \li \l {Add wizards}
\li \l {Open projects} \li \l {Create C++ classes}
\li \l {Specify project contents} \li \l {Create files}
\li \l {Select the build system} \li \l {Create OpenGL fragment and vertex shaders}
\li \l {Use project wizards} \li \l {Create resource files}
\endlist \li \l {Create VCS repositories for new projects}
\li \l {Select the build system}
\li \l {Use project wizards}
\endlist
\li
\list
\li \l {Activate kits for a project}
\li \l {Develop Qt for Python applications}
\li \l {Open projects}
\li \l {Specify project contents}
\endlist
\endtable
\section1 Read Qt Documentation \section1 Read Qt Documentation

View File

@@ -169,7 +169,7 @@
\uicontrol Preferences > \uicontrol Environment > \uicontrol Keyboard > \uicontrol Preferences > \uicontrol Environment > \uicontrol Keyboard >
\uicontrol Wizard. All wizard actions start with \uicontrol Impl there. \uicontrol Wizard. All wizard actions start with \uicontrol Impl there.
\sa {Assign keyboard shortcuts}, {Activating Kits for a Project}, \sa {Assign keyboard shortcuts}, {Activate kits for a project},
{Create files}, {Creating Projects} {Create files}, {Creating Projects}
*/ */

View File

@@ -1,4 +1,4 @@
// Copyright (C) 2021 The Qt Company Ltd. // Copyright (C) 2023 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
// ********************************************************************** // **********************************************************************
@@ -8,27 +8,63 @@
// ********************************************************************** // **********************************************************************
/*! /*!
\previouspage creator-vcs-subversion.html \previouspage creator-version-control.html
\page creator-configuring-projects.html \page creator-configuring-projects.html
\nextpage creator-targets.html \nextpage creator-project-managing-sessions.html
\title Configuring Projects \title Configuring Projects
When you install Qt for a target platform, such as Android or QNX, the When you install Qt for a target platform, such as Android or QNX, the
\l{https://www.qt.io/download-qt-installer}{Qt Online Installer} \l{https://www.qt.io/download-qt-installer}{Qt Online Installer}
creates \l{glossary-buildandrun-kit}{kits} for the development creates \l{glossary-buildandrun-kit}{kits} for the development
targets. Select the kits to use in the \uicontrol {Configure Projects} targets.
Select the kits to use in the \uicontrol {Configure Projects}
view when you open a project for the first time. At least one kit must be view when you open a project for the first time. At least one kit must be
active. For more information about selecting the initial kit, see active.
\l{Open projects}.
To maintain the list of active kits for a currently open project, switch to To maintain the list of active kits for a currently open project, switch to
the \uicontrol Projects mode by pressing \key Ctrl+5. the \uicontrol Projects mode by pressing \key Ctrl+5.
\section1 Activating Kits for a Project \image qtcreator-projects-kits.webp {Sidebar in the Projects mode}
The \uicontrol {Build & Run} section of the sidebar lists the kits that are To specify build or run settings for a kit, select \uicontrol Build or
compatible with your project. To activate one or more kits, click them. \uicontrol Run below the kit.
\section1 Overriding Global Preferences
You can override the following global preferences for each project:
\list
\li \l{Specifying Editor Settings}{Editor}
\li \l{Specifying Code Style}{Code Style}
\li \l{Specifying Dependencies}{Dependencies}
\li \l{Specifying Environment Settings}{Environment}
\li \l{Using Custom Output Parsers}{Custom Output Parsers}
\li \l{Applying Refactoring Actions}{Quick Fixes}
\li \l{Using Clang Tools}{Clang Tools}
\li \l{To-Do Entries}{To-Do} (experimental)
\li \l{Parsing C++ Files with the Clang Code Model}{Clangd}
\endlist
If you have multiple projects open in \QC, select the project to configure
in \uicontrol {Active Project}.
\sa {Activate kits for a project}, {Open projects},
{Specifying Build Settings}, {Specifying Run Settings}
*/
/*!
\page creator-how-to-activate-kits.html
\previouspage creator-how-tos.html
\ingroup creator-how-to-projects
\title Activate kits for a project
The \uicontrol {Build & Run} section of the \uicontrol Projects mode sidebar
lists the kits that are compatible with your project. To activate one or more
kits, click them.
\image qtcreator-project-kits.png \image qtcreator-project-kits.png
@@ -45,13 +81,14 @@
configuration to use a currently installed Qt version and save the kit configuration to use a currently installed Qt version and save the kit
under a new name. under a new name.
To modify kit configuration or to add kits to the list or to remove \section1 Manage kits
them from it, select \uicontrol {Manage Kits}. For more information
about managing kits, see \l{Adding Kits}. To modify kit configuration or to \l{Adding Kits}{add kits} to the list or to
remove them from it, select \uicontrol {Manage Kits}.
Each kit consists of a set of values that define one environment, such as a Each kit consists of a set of values that define one environment, such as a
\l{glossary-device}{device}, compiler, and Qt version. For more information, \l{glossary-device}{device}, \l{Adding Compilers}{compiler},
see \l{Adding Qt Versions}, \l{Adding Compilers}, and \l{Adding Debuggers}. \l{Adding Debuggers}{debugger}, and \l{Adding Qt Versions}{Qt version}.
To copy the build and run settings for a kit to another kit, select To copy the build and run settings for a kit to another kit, select
\uicontrol {Copy Steps from Other Kit} in the context menu. \uicontrol {Copy Steps from Other Kit} in the context menu.
@@ -65,38 +102,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}.
\section1 Specifying Settings \sa {Adding Kits}, {Configuring Projects}
To specify build or run settings for a kit, select \uicontrol Build or
\uicontrol Run below the kit. For more information, see
\l{Specifying Build Settings} and \l{Specifying Run Settings}.
In addition, you can modify the following global settings for each project:
\list
\li \l{Specifying Editor Settings}{Editor}
\li \l{Specifying Code Style}{Code Style}
\li \l{Specifying Dependencies}{Dependencies}
\li \l{Specifying Environment Settings}{Environment}
\li \l{Using Custom Output Parsers}{Custom Output Parsers}
\li \l{Applying Refactoring Actions}{Quick Fixes}
\li \l{Using Clang Tools}{Clang Tools}
\li \l{To-Do Entries}{To-Do} (experimental)
\li \l{Parsing C++ Files with the Clang Code Model}
{Clangd}
\endlist
If you have multiple projects open in \QC, select the project to configure
in the list of projects.
*/ */

View File

@@ -211,6 +211,7 @@
\endlist \endlist
\li Manage Projects \li Manage Projects
\list \list
\li \l {Activate kits for a project}
\li \l {Add a license header template for C++ code} \li \l {Add a license header template for C++ code}
\li \l {Add libraries to projects} \li \l {Add libraries to projects}
\li \l {Add subprojects to projects} \li \l {Add subprojects to projects}

View File

@@ -35,7 +35,7 @@
\li Kit selector \li Kit selector
\li Select the appropriate \l{glossary-buildandrun-kit}{kit} for building \li Select the appropriate \l{glossary-buildandrun-kit}{kit} for building
the project and running it on particular hardware. the project and running it on particular hardware.
\li \l{Activating Kits for a Project} \li \l{Activate kits for a project}
\row \row
\li \inlineimage numbers/03.png \li \inlineimage numbers/03.png
\li Run button \li Run button