Doc: Describe using variables in "Default build directory" field

In Preferences > Build & Run > Default Build Properties

Fixes: QTCREATORBUG-29779
Change-Id: Ic893058d081655e21a294b0dcc25ccb0184f4564
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
This commit is contained in:
Leena Miettinen
2023-10-25 14:02:57 +02:00
parent 9d4c31cb74
commit 70ed0aaa82
5 changed files with 25 additions and 10 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.2 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.6 KiB

View File

@@ -94,7 +94,7 @@
You can enable or disable QML debugging globally in \preferences > You can enable or disable QML debugging globally in \preferences >
\uicontrol {Build & Run} > \uicontrol {Default Build Properties}. \uicontrol {Build & Run} > \uicontrol {Default Build Properties}.
\image qtcreator-build-settings-default.png "Default Build Properties tab in Build & Run Preferences" \image qtcreator-build-settings-default.webp "Default Build Properties tab in Build & Run Preferences"
The value of the \uicontrol {QML debugging} field determines what happens The value of the \uicontrol {QML debugging} field determines what happens
when creating new build configurations. The values \uicontrol Enable when creating new build configurations. The values \uicontrol Enable

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,15 +8,22 @@
\title qmake Build Configuration \title qmake Build Configuration
\image qtcreator-projectpane.png "qmake build settings" Specify build settings for the selected \l{glossary-buildandrun-kit}
{build and run kit} in \uicontrol Projects > \uicontrol {Build & Run}
> \uicontrol Build > \uicontrol {Build Settings}.
\image qtcreator-projectpane.webp {qmake build settings}
By default, \QC builds qmake projects in a separate directory from the By default, \QC builds qmake projects in a separate directory from the
source directory, as \l{glossary-shadow-build} {shadow builds}. This source directory, as \l{glossary-shadow-build} {shadow builds}. This
keeps the files generated for each \l{glossary-buildandrun-kit} keeps the files generated for each kit separate. If you only build and
{build and run kit} separate. If you only build and run with a single run with a single kit, you can deselect the \uicontrol {Shadow build}
\l{glossary-buildandrun-kit}{kit}, you can deselect the checkbox.
\uicontrol {Shadow build} checkbox. Select the build directory in the
\uicontrol {Build Directory} field. Select the build directory in the \uicontrol {Build Directory} field. You
can use the \l{Using Qt Creator Variables}{variables} that are listed when
you select the \inlineimage icons/replace.png (\uicontrol {Variables})
button.
To make in-source builds the default option for all projects, select To make in-source builds the default option for all projects, select
\preferences > \uicontrol {Build & Run} > \preferences > \uicontrol {Build & Run} >
@@ -54,7 +61,14 @@
To set the default build properties, select \preferences > To set the default build properties, select \preferences >
\uicontrol {Build & Run} > \uicontrol {Default Build Properties}. \uicontrol {Build & Run} > \uicontrol {Default Build Properties}.
\image qtcreator-build-settings-default.png "Default Build Properties tab in Build & Run Preferences" \image qtcreator-build-settings-default.webp {Default Build Properties tab in Build & Run Preferences}
In the \uicontrol {Default build directory} field, you can use the variables
that are listed when you select \inlineimage icons/replace.png, as well as
variables that are available for a particular kit. Those you can see when
you select the button in the \uicontrol Projects > \uicontrol {Build & Run} >
\uicontrol Build > \uicontrol {Build Settings} > \uicontrol {Build Directory}
field for a kit.
\section1 Compiling QML \section1 Compiling QML

View File

@@ -35,7 +35,8 @@
\section1 Managing Build Configurations \section1 Managing Build Configurations
Specify build settings in \uicontrol Projects > \uicontrol {Build & Run} Specify build settings for the selected \l{glossary-buildandrun-kit}
{build and run kit} in \uicontrol Projects > \uicontrol {Build & Run}
> \uicontrol Build > \uicontrol {Build Settings}. > \uicontrol Build > \uicontrol {Build Settings}.
\image qtcreator-build-configurations.png "Build Settings" \image qtcreator-build-configurations.png "Build Settings"