feedc0de/qt-creator
1
0
Fork 0
forked from qt-creator/qt-creator
Code Pull Requests Activity

Doc: Restructure info about build and run configurations

Browse Source 
Task-number: QTCREATORBUG-29361
Change-Id: I9e9d3a3448c327938e4f647b37a88857db5b16c4
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
This commit is contained in:
Leena Miettinen
2023-11-06 18:22:45 +01:00
parent f7b1eed0c2
commit f708e200f9
48 changed files with 573 additions and 376 deletions
Download Patch File Download Diff File Expand all files Collapse all files

0
doc/qtdesignstudio/images/icons/close.png → doc/qtcreator/images/icons/close.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 174 B

After

Width:  |  Height:  |  Size: 174 B

BIN
doc/qtcreator/images/qmldesigner-run-custom-exe.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 16 KiB

BIN
doc/qtcreator/images/qmldesigner-run-settings.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 4.8 KiB

BIN
doc/qtcreator/images/qtcreator-cmake-build-steps.webp
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 7.5 KiB

After

Width:  |  Height:  |  Size: 9.7 KiB

BIN
doc/qtcreator/images/qtcreator-run-settings-custom-executable.webp Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 4.5 KiB

BIN
doc/qtcreator/images/qtquick-ui-prototype-run-settings.webp Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 5.1 KiB

1
doc/qtcreator/src/analyze/creator-valgrind-overview.qdoc
View File

@@ -50,4 +50,5 @@
\endlist \endlist
\sa {Specify Valgrind settings for a project}
*/ */

30
doc/qtcreator/src/android/creator-projects-settings-run-android.qdocinc → doc/qtcreator/src/android/creator-projects-settings-run-android.qdoc
View File

@@ -1,16 +1,27 @@
// 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
/*! /*!
//! [run settings android] \page creator-run-settings-android.html
\previouspage creator-reference.html
\section1 Specifying Run Settings for Android Devices \ingroup creator-reference-run-configurations
\title Android Run Settings
\brief Settings for running applications on Android devices.
Specify settings for running applications on the \l {Kits}{Run device} that
you select for a kit in \uicontrol Projects > \uicontrol {Build & Run} >
\uicontrol Run > \uicontrol {Run Settings}.
To run and debug an application on an Android device, you must create To run and debug an application on an Android device, you must create
connections from the development host to the device, as instructed in connections from the development host to the device, as instructed in
\l {Connecting Android Devices}. \l {Connecting Android Devices}.
A default set of Android Activity manager (am) start options is applied when \section1 am Start Options
\QC applies a default set of Android Activity manager (am) start options when
starting applications. You can specify additional start options in the starting applications. You can specify additional start options in the
\uicontrol {Activity manager start arguments} field. However, if the default \uicontrol {Activity manager start arguments} field. However, if the default
options conflict with the added options, the application might not start. options conflict with the added options, the application might not start.
@@ -30,10 +41,12 @@
For example, to run the application as a particular user, enter the start For example, to run the application as a particular user, enter the start
option \c {--user 10}, where \c 10 is the user ID of the user account. option \c {--user 10}, where \c 10 is the user ID of the user account.
\image qtcreator-android-run-settings.png \image qtcreator-android-run-settings.png {Run Settings for an Android device}
You can specify shell commands to run before the application is started \section1 Shell Commands
and after it is quit. For example, enter the following commands into
You can specify shell commands to run before the application starts
and after it quits. For example, enter the following commands into
\uicontrol{Pre-launch on-device shell commands} to unlock the screen and \uicontrol{Pre-launch on-device shell commands} to unlock the screen and
to switch to the user account \c 10 on the device before running the to switch to the user account \c 10 on the device before running the
application: application:
@@ -52,5 +65,6 @@
input keyevent 82 input keyevent 82
\endcode \endcode
//! [run settings android] \sa {Activate kits for a project}, {Configure projects for running},
{Connecting Android Devices}
*/ */

4
doc/qtcreator/src/android/deploying-android.qdoc
View File

@@ -36,7 +36,7 @@
\uicontrol {Build Android APK} > \uicontrol Details. \uicontrol {Build Android APK} > \uicontrol Details.
For more information about options that you have for running applications, For more information about options that you have for running applications,
see \l {Specifying Run Settings for Android Devices}. see \l {Android Run Settings}.
\section1 Packaging Applications \section1 Packaging Applications
@@ -65,7 +65,7 @@
\uicontrol Manage. \uicontrol Manage.
For more information about specifying additional start options for For more information about specifying additional start options for
applications, see \l{Specifying Run Settings for Android Devices}. applications, see \l{Android Run Settings}.
To remove previously installed files from the device, select To remove previously installed files from the device, select
\uicontrol {Uninstall the existing app before deployment}. \uicontrol {Uninstall the existing app before deployment}.

18
doc/qtcreator/src/cmake/creator-projects-cmake-building.qdoc
View File

@@ -2,19 +2,26 @@
// 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
/*! /*!
\previouspage creator-build-settings.html
\page creator-build-settings-cmake.html \page creator-build-settings-cmake.html
\nextpage creator-build-settings-cmake-presets.html \previouspage creator-reference.html
\ingroup creator-reference-build-configurations
\title CMake Build Configuration \title CMake Build Configuration
\brief Settings for building applications with CMake.
Specify build settings for the selected \l{glossary-buildandrun-kit}{kit} in
\uicontrol Projects > \uicontrol {Build & Run} > \uicontrol Build >
\uicontrol {Build Settings}.
Configuring medium-sized to large CMake projects in \QC can be a Configuring medium-sized to large CMake projects in \QC can be a
challenge due to the number of variables that you need to pass to challenge due to the number of variables that you need to pass to
CMake to configure the project correctly. To make this easier, CMake to configure the project correctly. To make this easier,
\QC creates an initial configuration for you based on the kit \QC creates an initial configuration for you based on the kit
settings and displays it in \uicontrol {Initial Configuration} in settings and displays it in \uicontrol {Initial Configuration} in
the \l{Specifying Build Settings}{Build Settings} of the project. the \uicontrol {Build Settings} of the project.
Alternatively, you can use CMake presets to configure CMake. Or, you can use CMake presets to configure CMake.
The \uicontrol Configure field displays the effective CMake call that The \uicontrol Configure field displays the effective CMake call that
\QC constructs using the values of the \uicontrol {Build directory} and \QC constructs using the values of the \uicontrol {Build directory} and
@@ -257,4 +264,7 @@
\image qtcreator-cmake-clean-steps.webp {CMake clean steps} \image qtcreator-cmake-clean-steps.webp {CMake clean steps}
The build errors and warnings are parsed and displayed in \l Issues. The build errors and warnings are parsed and displayed in \l Issues.
\sa {Activate kits for a project}, {Configure projects for building},
{Configure projects for running}, {Open projects}, {CMake}
*/ */

9
doc/qtcreator/src/cmake/creator-projects-cmake-presets.qdoc
View File

@@ -2,12 +2,15 @@
// 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
/*! /*!
\previouspage creator-build-settings-cmake.html
\page creator-build-settings-cmake-presets.html \page creator-build-settings-cmake-presets.html
\nextpage creator-build-settings-qmake.html \previouspage creator-reference.html
\ingroup creator-reference-build-configurations
\title CMake Presets \title CMake Presets
\brief Examples of supported CMake presets.
\c CMakePresets.json has options for project-wide builds, whereas \c CMakePresets.json has options for project-wide builds, whereas
\c CMakeUserPresets.json has options for your local builds. \c CMakeUserPresets.json has options for your local builds.
@@ -224,4 +227,6 @@
] ]
} }
\endcode \endcode
\sa {CMake Build Configuration}, {CMake}
*/ */

7
doc/qtcreator/src/cmake/creator-projects-cmake.qdoc
View File

@@ -47,10 +47,9 @@
Typically, you cannot compile such projects without manual changes. Typically, you cannot compile such projects without manual changes.
\endlist \endlist
\sa {Build with CMake}{How To: Build with CMake}, {Open projects}, \sa {Build with CMake}{How To: Build with CMake}, {CMake Build Configuration},
{CMake Build Configuration}, {Debug CMake project files}, {Configure projects for building}, {Configure projects for running},
{Specifying Build Settings}, {Specifying Run Settings}, {Debug CMake project files}, {Deploying to Remote Linux}, {Open projects}
{Deploying to Remote Linux}
*/ */
/*! /*!

6
doc/qtcreator/src/editors/creator-only/creator-compilation-database.qdocinc
View File

@@ -31,10 +31,10 @@
\uicontrol C++ > \uicontrol {Switch Header/Source}. \uicontrol C++ > \uicontrol {Switch Header/Source}.
You can specify custom build steps and run settings for compilation You can specify custom build steps and run settings for compilation
database projects in the \uicontrol Projects mode. For more information, database projects in the \uicontrol Projects mode.
see \l{Adding Custom Build Steps} and \l {Specifying Run Settings}.
\sa {Enable and disable plugins} \sa {Enable and disable plugins}, {Add custom build steps},
{Configure projects for running}
//! [using compilation databases] //! [using compilation databases]
*/ */

2
doc/qtcreator/src/howto/creator-only/creator-autotest.qdoc
View File

@@ -438,7 +438,7 @@
or select \uicontrol {Reset Cached Choices}. or select \uicontrol {Reset Cached Choices}.
Select the \uicontrol {Process arguments} check box to pass arguments to the Select the \uicontrol {Process arguments} check box to pass arguments to the
test executable that you specify in the \l {Managing Run Configurations} test executable that you specify in the \l {Configure projects for running}
{run configuration}. This is an experimental feature that might cause the {run configuration}. This is an experimental feature that might cause the
execution of the test executable to fail. execution of the test executable to fail.

4
doc/qtcreator/src/howto/creator-only/creator-how-tos.qdoc
View File

@@ -37,6 +37,10 @@
\generatelist creator-how-to-build-with-qmake \generatelist creator-how-to-build-with-qmake
\section2 Run applications
\generatelist creator-how-to-run
\section1 Debug \section1 Debug
\generatelist creator-how-to-debug \generatelist creator-how-to-debug

22
doc/qtcreator/src/incredibuild/creator-projects-incredibuild-building.qdoc
View File

@@ -1,12 +1,19 @@
// 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
/*! /*!
\previouspage creator-build-settings-meson.html
\page creator-build-settings-incredibuild.html \page creator-build-settings-incredibuild.html
\nextpage creator-build-settings-conan.html \previouspage creator-reference.html
\ingroup creator-reference-build-configurations
\title IncrediBuild Build Configuration \title IncrediBuild Build Configuration
\brief Build and clean steps for Incredibuild.
Specify build settings for the selected \l{glossary-buildandrun-kit}{kit} in
\uicontrol Projects > \uicontrol {Build & Run} > \uicontrol Build >
\uicontrol {Build Settings}.
You can specify build steps and clean steps for IncrediBuild. You can specify build steps and clean steps for IncrediBuild.
For more information about configuring IncrediBuild, see For more information about configuring IncrediBuild, see
@@ -114,10 +121,11 @@
\section1 IncrediBuild Clean Steps \section1 IncrediBuild Clean Steps
When building with IncrediBuild, you can add arguments and targets for the When building with IncrediBuild, you can add arguments and targets for the
clean command in \uicontrol {Clean Steps}. For more information, see clean command in \uicontrol {Clean Steps}.
\l{Clean Steps}.
For more information about the settings, see \l{IncrediBuild Build Steps}.
The build errors and warnings are parsed and displayed in \l Issues. The build errors and warnings are parsed and displayed in \l Issues.
\sa {Activate kits for a project}, {Add clean steps},
{Configure projects for building}, {Configure projects for running},
{Open projects}, {Configuring projects}, {Setting Up IncrediBuild}
*/ */

2
doc/qtcreator/src/linux-mobile/b2qtdev.qdoc
View File

@@ -146,6 +146,6 @@
When you run the project, \QC deploys the application as When you run the project, \QC deploys the application as
specified by the deploy steps. By default, \QC copies the specified by the deploy steps. By default, \QC copies the
application files to the device. For more information, see application files to the device. For more information, see
\l{Specifying Run Settings for Boot2Qt Devices}. \l{Boot2Qt Run Settings}.
\endlist \endlist
*/ */

6
doc/qtcreator/src/linux-mobile/creator-embedded-platforms.qdoc
View File

@@ -58,7 +58,7 @@
\li \l{https://doc.qt.io/Boot2Qt/b2qt-installation-guides.html} \li \l{https://doc.qt.io/Boot2Qt/b2qt-installation-guides.html}
{Boot2Qt: Installation Guides} {Boot2Qt: Installation Guides}
\li \l{Connecting Boot2Qt Devices} \li \l{Connecting Boot2Qt Devices}
\li \l{Specifying Run Settings for Boot2Qt Devices} \li \l{Boot2Qt Run Settings}
\li \l{Deploying to Boot2Qt} \li \l{Deploying to Boot2Qt}
\li \l{https://doc.qt.io/qtcreator/creator-overview-qtasam.html} \li \l{https://doc.qt.io/qtcreator/creator-overview-qtasam.html}
{Qt Creator Plugin for Qt Application Manager} {Qt Creator Plugin for Qt Application Manager}
@@ -75,7 +75,7 @@
\list \list
\li \l{Connecting Remote Linux Devices} \li \l{Connecting Remote Linux Devices}
\li \l{Deploying to Remote Linux} \li \l{Deploying to Remote Linux}
\li \l{Specifying Run Settings for Linux-Based Devices} \li \l{Remote Linux Run Settings}
\li \l{Running on Remote Linux Devices} \li \l{Running on Remote Linux Devices}
\li \l{https://doc.qt.io/qtcreator/creator-overview-qtasam.html} \li \l{https://doc.qt.io/qtcreator/creator-overview-qtasam.html}
{Qt Creator Plugin for Qt Application Manager} {Qt Creator Plugin for Qt Application Manager}
@@ -109,7 +109,7 @@
\list \list
\li \l{Connecting QNX Devices} \li \l{Connecting QNX Devices}
\li \l{Deploying to QNX Neutrino} \li \l{Deploying to QNX Neutrino}
\li \l{Specifying Run Settings for QNX Devices} \li \l{QNX Run Settings}
\li \l{Running on QNX Devices} \li \l{Running on QNX Devices}
\li \l{Qt for QNX} \li \l{Qt for QNX}
\endlist \endlist

2
doc/qtcreator/src/linux-mobile/creator-projects-running-generic-linux.qdocinc
View File

@@ -28,7 +28,7 @@
In the \uicontrol {Projects} mode, select the remote Linux kit and then In the \uicontrol {Projects} mode, select the remote Linux kit and then
select \uicontrol {Run} to view the settings for deploying the application select \uicontrol {Run} to view the settings for deploying the application
to the connected device. For more information, see to the connected device. For more information, see
\l{Specifying Run Settings for Linux-Based Devices}. \l{Remote Linux Run Settings}.
Debugging works transparently if GDB server is installed on the device and Debugging works transparently if GDB server is installed on the device and
it is compatible with the GDB on the host. it is compatible with the GDB on the host.

30
doc/qtcreator/src/linux-mobile/creator-projects-settings-run-b2qt.qdoc Normal file
View File

@@ -0,0 +1,30 @@
// Copyright (C) 2023 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
\page creator-run-settings-boot2qt.html
\previouspage creator-reference.html
\ingroup creator-reference-run-configurations
\title Boot2Qt Run Settings
\brief Settings for running applications on Boot2Qt devices.
Specify settings for running applications on the \l {Kits}{Run device} that
you select for a kit in \uicontrol Projects > \uicontrol {Build & Run} >
\uicontrol Run > \uicontrol {Run Settings}.
To run and debug an application on a \l Boot2Qt device (commercial only), you
must create connections from the development host to the device and add the
device configurations to kits. Select \uicontrol {Manage Kits} to add devices
to kits. For more information, see
\l{http://doc.qt.io/Boot2Qt/b2qt-installation-guides.html}
{Boot2Qt: Installation Guide}.
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},
{Deploying to Boot2Qt}
*/

23
doc/qtcreator/src/linux-mobile/creator-projects-settings-run-b2qt.qdocinc
View File

@@ -1,23 +0,0 @@
// Copyright (C) 2021 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
//! [run settings boot2qt]
\section1 Specifying Run Settings for Boot2Qt Devices
To run and debug an application on a \l Boot2Qt device (commercial only), you
must create connections from the development host to the device and add the
device configurations to \l{glossary-buildandrun-kit}{kits}. Select
\uicontrol {Manage Kits} to add devices to kits. For more information, see
\l{http://doc.qt.io/Boot2Qt/b2qt-installation-guides.html}
{Boot2Qt: Installation Guide}.
The run settings display the path to the executable file on the development
host and on the device.
For more information on the deployment steps, see
\l{Deploying to Boot2Qt}.
//! [run settings boot2qt]
*/

25
doc/qtcreator/src/linux-mobile/creator-projects-settings-run-linux.qdocinc → doc/qtcreator/src/linux-mobile/creator-projects-settings-run-linux.qdoc
View File

@@ -1,15 +1,23 @@
// Copyright (C) 2020 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
/*! /*!
//! [run settings linux] \page creator-run-settings-remote-linux.html
\previouspage creator-reference.html
\section1 Specifying Run Settings for Linux-Based Devices \ingroup creator-reference-run-configurations
To run and debug an application on a Linux-based device, \title Remote Linux Run Settings
you must create connections from the development
host to the device and add the device configurations to \brief Settings for running applications on Linux-based devices.
\l{glossary-buildandrun-kit}{kits}. Click \uicontrol {Manage Kits} to add devices
Specify run settings for the selected \l{glossary-buildandrun-kit}{kit} in
\uicontrol Projects > \uicontrol {Build & Run} > \uicontrol Run >
\uicontrol {Run Settings}.
To run and debug an application on a Linux-based device, you must create
connections from the development host to the device and add the device
configurations to kits. Select \uicontrol {Manage Kits} to add devices
to kits. For more information, see to kits. For more information, see
\l {Connecting Remote Linux Devices}. \l {Connecting Remote Linux Devices}.
@@ -29,5 +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.
//! [run settings linux] \sa {Activate kits for a project}, {Configure projects for running}, {Kits},
{Connecting Remote Linux Devices}
*/ */

19
doc/qtcreator/src/meson/creator-projects-meson-building.qdoc
View File

@@ -1,13 +1,20 @@
// Copyright (C) 2022 The Qt Company Ltd. // Copyright (C) 2022 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
/*! /*!
\previouspage creator-build-settings-qbs.html
\page creator-build-settings-meson.html \page creator-build-settings-meson.html
\nextpage creator-build-settings-incredibuild.html \previouspage creator-reference.html
\ingroup creator-reference-build-configurations
\title Meson Build Configuration \title Meson Build Configuration
\image qtcreator-meson-build-settings.png "Meson build settings" \brief Settings for building applications with Meson.
Specify build settings for the selected \l{glossary-buildandrun-kit}{kit} in
\uicontrol Projects > \uicontrol {Build & Run} > \uicontrol Build >
\uicontrol {Build Settings}.
\image qtcreator-meson-build-settings.png {Meson build settings}
Meson builds projects in the directory specified in the Meson builds projects in the directory specified in the
\uicontrol {Build directory} field. \uicontrol {Build directory} field.
@@ -35,7 +42,7 @@
You can add arguments and targets for the build command in You can add arguments and targets for the build command in
\uicontrol {Build Steps}. \uicontrol {Build Steps}.
\image qtcreator-meson-build-steps.png "Meson build steps" \image qtcreator-meson-build-steps.png {Meson build steps}
The build errors and warnings are parsed and displayed in \l Issues. The build errors and warnings are parsed and displayed in \l Issues.
@@ -44,8 +51,10 @@
When building with Meson, you can add arguments and targets for the clean When building with Meson, you can add arguments and targets for the clean
command in \uicontrol {Clean Steps}. command in \uicontrol {Clean Steps}.
\image qtcreator-meson-clean-steps.png "Meson clean steps" \image qtcreator-meson-clean-steps.png {Meson clean steps}
The build errors and warnings are parsed and displayed in \uicontrol Issues. The build errors and warnings are parsed and displayed in \uicontrol Issues.
\sa {Activate kits for a project}, {Configure projects for building},
{Configure projects for running}, {Open projects}, {Configuring projects}
*/ */

8
doc/qtcreator/src/overview/creator-only/creator-reference.qdoc
View File

@@ -19,6 +19,14 @@
\annotatedlist creator-reference-build-systems \annotatedlist creator-reference-build-systems
\section1 Build Configurations
\annotatedlist creator-reference-build-configurations
\section1 Run Configurations
\annotatedlist creator-reference-run-configurations
\section1 Preferences \section1 Preferences
\annotatedlist creator-reference-preferences \annotatedlist creator-reference-preferences

85
doc/qtcreator/src/projects/creator-only/creator-build-settings-qmake.qdoc
View File

@@ -2,23 +2,28 @@
// 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
/*! /*!
\previouspage creator-build-settings-cmake-presets.html
\page creator-build-settings-qmake.html \page creator-build-settings-qmake.html
\nextpage creator-build-settings-qbs.html \previouspage creator-reference.html
\ingroup creator-reference-build-configurations
\title qmake Build Configuration \title qmake Build Configuration
Specify build settings for the selected \l{glossary-buildandrun-kit} \brief Settings for building applications with qmake.
{build and run kit} in \uicontrol Projects > \uicontrol {Build & Run}
Specify build settings for the selected \l{glossary-buildandrun-kit}{kit}
in \uicontrol Projects > \uicontrol {Build & Run}
> \uicontrol Build > \uicontrol {Build Settings}. > \uicontrol Build > \uicontrol {Build Settings}.
\image qtcreator-projectpane.webp {qmake build settings} \image qtcreator-projectpane.webp {qmake build settings}
By default, \QC builds qmake projects in a separate directory from the \section1 Build Directory
source directory, as \l{glossary-shadow-build} {shadow builds}. This
keeps the files generated for each kit separate. If you only build and By default, \QC builds qmake projects (that have .pro files) in a separate
run with a single kit, you can deselect the \uicontrol {Shadow build} directory from the source directory, as \l{glossary-shadow-build}
checkbox. {shadow builds}. This keeps the files generated for each kit separate. If
you only build and run with a single kit, you can deselect the
\uicontrol {Shadow build} checkbox.
Select the build directory in the \uicontrol {Build Directory} field. You Select the build directory in the \uicontrol {Build Directory} field. You
can use the \l{Use Qt Creator variables}{variables} that are listed when can use the \l{Use Qt Creator variables}{variables} that are listed when
@@ -30,6 +35,8 @@
\uicontrol {Default Build Properties}, and enter a period (.) in the \uicontrol {Default Build Properties}, and enter a period (.) in the
\uicontrol {Default build directory} field. \uicontrol {Default build directory} field.
\section1 Tooltips in Kit Selector
In the \uicontrol {Tooltip in target selector} field, you can enter text In the \uicontrol {Tooltip in target selector} field, you can enter text
that is displayed as a tooltip when you hover the mouse over the build that is displayed as a tooltip when you hover the mouse over the build
configuration in the \l{Building for Multiple Platforms}{kit selector}. configuration in the \l{Building for Multiple Platforms}{kit selector}.
@@ -39,37 +46,14 @@
{scopes} to select the file to process depending on which platform qmake is {scopes} to select the file to process depending on which platform qmake is
run on. run on.
\section1 Separating Debug Info
If debug info is being generated, you can have it placed into separate If debug info is being generated, you can have it placed into separate
files, rather than embedded into the binary, by selecting files, rather than embedded into the binary, by selecting
\uicontrol Enable in the \uicontrol {Separate debug info} field. For \uicontrol Enable in the \uicontrol {Separate debug info} field. For
more information, see \l{Using the Performance Analyzer}. To use default more information, see \l{Using the Performance Analyzer}. To use default
settings, select \uicontrol {Leave at Default}. settings, select \uicontrol {Leave at Default}.
In the \uicontrol {qmake system() behavior when parsing} field, you can
select whether processes are run via qmake's \c system() function or
ignored. Setting this option to \uicontrol Ignore might help if opening
or closing projects takes too long, but it might produce inexact parsing
results.
\section1 Global qmake Settings
To specify settings for all qmake builds, select \preferences >
\uicontrol {Build & Run} > \uicontrol Qmake.
\image qtcreator-preferences-build-run-qmake.png "Qmake tab in Build & Run Preferences"
To set the default build properties, select \preferences >
\uicontrol {Build & Run} > \uicontrol {Default Build Properties}.
\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
You can compile QML source code into the final binary to improve the You can compile QML source code into the final binary to improve the
@@ -85,12 +69,39 @@
You can specify default behavior for compiling QML code in \preferences > You can specify default behavior for compiling QML code in \preferences >
\uicontrol {Build & Run} > \uicontrol Qmake > \uicontrol {Use qmlcachegen}. \uicontrol {Build & Run} > \uicontrol Qmake > \uicontrol {Use qmlcachegen}.
\section1 Parsing Project Contents
In the \uicontrol {qmake system() behavior when parsing} field, you can
select whether processes are run via qmake's \c system() function or
ignored. Setting this option to \uicontrol Ignore might help if opening
or closing projects takes too long, but it might produce inexact parsing
results.
\section1 Global qmake Settings
To specify settings for all qmake builds, select \preferences >
\uicontrol {Build & Run} > \uicontrol Qmake.
\image qtcreator-preferences-build-run-qmake.png {Qmake tab in Build & Run Preferences}
To set the default build properties, select \preferences >
\uicontrol {Build & Run} > \uicontrol {Default Build Properties}.
\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 qmake Build Steps \section1 qmake Build Steps
\QC builds qmake projects by running the \c make or \c nmake command from \QC builds qmake projects by running the \c make or \c nmake command from
the Qt version defined for the current build configuration. the Qt version defined for the current build configuration.
\image qtcreator-build-steps.png "Build steps" \image qtcreator-build-steps.png {qmake build steps}
To override the shell command that \QC constructs by default, disable or To override the shell command that \QC constructs by default, disable or
remove the build step and add a custom build step that specifies another remove the build step and add a custom build step that specifies another
@@ -111,4 +122,8 @@
Select \uicontrol {Add Build Step} > \uicontrol {Run Conan Install} to use Select \uicontrol {Add Build Step} > \uicontrol {Run Conan Install} to use
the \l{Conan Build Configuration}{Conan} package manager with qmake the \l{Conan Build Configuration}{Conan} package manager with qmake
\sa {Activate kits for a project}, {Configure projects for building},
{Configure projects for running}, {Open projects}
*/ */

3
doc/qtcreator/src/projects/creator-only/creator-how-to-select-build-systems.qdoc
View File

@@ -56,5 +56,6 @@
Specify build and run settings for different target platforms, in the Specify build and run settings for different target platforms, in the
\uicontrol Projects mode. \uicontrol Projects mode.
\sa {Specifying Build Settings}, {Build Systems}, {Use project wizards} \sa {Configure projects for building}, {Configure projects for running},
{Build Systems}, {Use project wizards}
*/ */

3
doc/qtcreator/src/projects/creator-only/creator-projects-building.qdoc
View File

@@ -116,5 +116,6 @@
\image qtcreator-preferences-build-run-qmake.png "qmake tab in Build & Run Preferences" \image qtcreator-preferences-build-run-qmake.png "qmake tab in Build & Run Preferences"
For more information, see \l {qmake Build Configuration}. \sa {Configure projects for building}, {Configure projects for running},
{qmake Build Configuration}
*/ */

2
doc/qtcreator/src/projects/creator-only/creator-projects-opening.qdoc
View File

@@ -95,7 +95,7 @@
of the \uicontrol {Configure Project} tab and select \uicontrol {Import}. of the \uicontrol {Configure Project} tab and select \uicontrol {Import}.
You can edit the build configuration later. For more information, see You can edit the build configuration later. For more information, see
\l{Editing Build Configurations}. \l{Edit build configurations}.
\section1 Show progress information \section1 Show progress information

11
doc/qtcreator/src/projects/creator-only/creator-projects-settings-build-qbs.qdoc
View File

@@ -2,12 +2,19 @@
// 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
/*! /*!
\previouspage creator-build-settings-qmake.html
\page creator-build-settings-qbs.html \page creator-build-settings-qbs.html
\nextpage creator-build-settings-meson.html \previouspage creator-reference.html
\ingroup creator-reference-build-configurations
\title Qbs Build Configuration \title Qbs Build Configuration
\brief Settings for building applications with Qbs.
Specify build settings for the selected \l{glossary-buildandrun-kit}{kit} in
\uicontrol Projects > \uicontrol {Build & Run} > \uicontrol Build >
\uicontrol {Build Settings}.
\image qtcreator-build-settings-qbs.png {Qbs build settings} \image qtcreator-build-settings-qbs.png {Qbs build settings}
Qbs builds projects in the directory specified in the Qbs builds projects in the directory specified in the

104
doc/qtcreator/src/projects/creator-only/creator-projects-settings-build.qdoc
View File

@@ -1,4 +1,4 @@
// Copyright (C) 2022 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,41 +8,25 @@
// ********************************************************************** // **********************************************************************
/*! /*!
\previouspage creator-debuggers.html
\page creator-build-settings.html \page creator-build-settings.html
\nextpage creator-build-settings-cmake.html \previouspage creator-how-tos.html
\title Specifying Build Settings \ingroup creator-how-to-projects
\ingroup creator-how-to-build
Different build configurations allow you to quickly switch between \title Configure projects for building
different build settings. By default, \QC creates \e debug, \e release, and
\e profile build configurations. A debug build has additional
debug symbols that you need for debugging the application but that you
can leave out from the release version. Generally, you use the debug
configuration for testing and the release configuration for creating
the final installation binary package.
If you selected CMake as the build system for the project, you can Specify build settings for the selected \l{glossary-buildandrun-kit}{kit} in
use a \e {minimum size release} build configuration to create the \uicontrol Projects > \uicontrol {Build & Run} > \uicontrol Build >
final installation binary package. It is a release build that makes the size \uicontrol {Build Settings}.
of the binary package as small as possible, even if this makes the
application slower.
A profile build (which is called \e {release with debug information} \image qtcreator-build-configurations.png {Build Settings}
when using CMake) is an optimized release build that is delivered
with separate debug information. It is best suited for analyzing
applications.
\section1 Managing Build Configurations \section1 Manage build configurations
Specify build settings for the selected \l{glossary-buildandrun-kit} To add a new build configuration to the list in
{build and run kit} in \uicontrol Projects > \uicontrol {Build & Run} \uicontrol {Edit build configuration}, click \uicontrol Add and select the
> \uicontrol Build > \uicontrol {Build Settings}. type of configuration to add. The options you have depend on the
\image qtcreator-build-configurations.png "Build Settings"
To add a new build configuration, click \uicontrol Add and select the type of
configuration you would like to add. The options you have depend on the
build system that you selected for the project. You can add as many build build system that you selected for the project. You can add as many build
configurations as you need. You can also select \uicontrol Clone to configurations as you need. You can also select \uicontrol Clone to
add a build configuration that is based on the currently selected one. add a build configuration that is based on the currently selected one.
@@ -50,9 +34,9 @@
Select \uicontrol Rename to give the currently selected build configuration Select \uicontrol Rename to give the currently selected build configuration
a new name. a new name.
To delete the build configuration currently selected, click \uicontrol Remove. To delete the currently selected build configuration, click \uicontrol Remove.
\section1 Editing Build Configurations \section1 Edit build configurations
Select the build configuration to edit in the Select the build configuration to edit in the
\uicontrol {Edit build configuration} field. \uicontrol {Edit build configuration} field.
@@ -70,10 +54,7 @@
This topic describes the build settings at a general level. This topic describes the build settings at a general level.
For more information about debugging Qt Quick projects, see \section1 Build on remote devices
\l{Setting Up QML Debugging}.
\section1 Building on Remote Devices
You can build applications on \l{Connecting Remote Linux Devices} You can build applications on \l{Connecting Remote Linux Devices}
{remote Linux} or \l{Adding Docker Devices}{Docker} devices if you {remote Linux} or \l{Adding Docker Devices}{Docker} devices if you
@@ -86,7 +67,7 @@
Also, the \uicontrol {Open Terminal} button in the Also, the \uicontrol {Open Terminal} button in the
\uicontrol {Build Environment} section opens a terminal on the device. \uicontrol {Build Environment} section opens a terminal on the device.
\section1 Starting External Processes \section1 Start external processes
\QC executes external processes to accomplish tasks such as building \QC executes external processes to accomplish tasks such as building
and running applications. To execute the processes, \QC uses shell and running applications. To execute the processes, \QC uses shell
@@ -111,9 +92,10 @@
\uicontrol Executable field is always placed first when constructing the command. \uicontrol Executable field is always placed first when constructing the command.
You can \l {Use Qt Creator variables}{use \QC variables} in arguments, You can \l {Use Qt Creator variables}{use \QC variables} in arguments,
executable paths, and working directories. executable paths, and working directories. That is, in all fields where you
see the \inlineimage icons/replace.png (\uicontrol {Variables}) button.
\section1 Build Steps \section1 Add build steps
\image qtcreator-cmake-build-steps.webp {CMake build steps} \image qtcreator-cmake-build-steps.webp {CMake build steps}
@@ -131,26 +113,35 @@
You can use \l{IncrediBuild Build Steps}{IncrediBuild} to accelerate the You can use \l{IncrediBuild Build Steps}{IncrediBuild} to accelerate the
build process when using qmake or CMake. build process when using qmake or CMake.
\section2 Adding Custom Build Steps To manage build steps:
\list
\li To add a build step, select \uicontrol {Add Build Step} and select
the step to add.
\li To disable a step you added, select
\inlineimage icons/buildstepdisable.png (\uicontrol {Disable}).
\li To change the order of steps, select \inlineimage icons/arrowup.png
(\uicontrol {Move Up}) and \inlineimage icons/arrowdown.png
(\uicontrol {Move Down}).
\li To remove a step, select \inlineimage icons/close.png
(\uicontrol {Remove Item}).
\endlist
\section2 Add custom build steps
To add custom steps to the build settings, select To add custom steps to the build settings, select
\uicontrol {Add Build Step} > \uicontrol {Custom Process Step}. \uicontrol {Add Build Step} > \uicontrol {Custom Process Step}.
By default, custom steps are enabled. To disable a custom step, select
the \inlineimage icons/buildstepdisable.png
(\uicontrol Disable) button.
\image qtcreator-build-steps-custom.png "Custom Process Step" \image qtcreator-build-steps-custom.png {Custom Process Step}
\section2 Executing Custom Commands \section2 Execute custom commands
To execute custom commands when building for embedded devices, select To execute custom commands when building for embedded devices, select
\uicontrol {Add Build Step} > \uicontrol {Custom Remote Command \uicontrol {Add Build Step} > \uicontrol {Custom Remote Command
(via adb shell)} (commercial only) and enter the command to execute. (via adb shell)} (commercial only) and enter the command to execute.
\section1 Clean Steps \section1 Add clean steps
\image qtcreator-clean-steps.png "Clean steps"
You can use the cleaning process to remove intermediate files. This process You can use the cleaning process to remove intermediate files. This process
might help you to fix obscure issues during the process of building a might help you to fix obscure issues during the process of building a
@@ -165,19 +156,12 @@
\endlist \endlist
You can define the clean steps for your builds in \uicontrol {Clean Steps}. You can define the clean steps for your builds in \uicontrol {Clean Steps}.
To add a clean step using make or a custom process, select
\uicontrol{Add Clean Step} and select the step to add.
\list \image qtcreator-cmake-clean-steps.webp {Clean steps}
\li To add a clean step using make or a custom process, click \sa {Configuring Projects}, {Select the build system}, {Use \QC variables},
\uicontrol{Add Clean Step} and select the type of step you want to add. {Enable debugging}, {Setting Up QML Debugging},
{Build Systems}{Reference: Build Systems}
By default, custom steps are enabled. To disable a custom step,
select the \uicontrol Disable button.
\li To remove a clean step, click \uicontrol{Remove Item}.
\li To change the order of steps, click \inlineimage icons/arrowup.png
(\uicontrol {Move Up}) and \inlineimage icons/arrowdown.png
(\uicontrol {Move Down}).
\endlist
*/ */

8
doc/qtcreator/src/projects/creator-only/creator-projects-settings-environment.qdoc
View File

@@ -93,8 +93,8 @@
fetches information about the \uicontrol {Device Environment} from the device. fetches information about the \uicontrol {Device Environment} from the device.
Usually, it does not make sense to edit the device environment. Usually, it does not make sense to edit the device environment.
\sa {Batch edit environment settings}, {Specifying Build Settings}, \sa {Batch edit environment settings}, {Configure projects for building},
{Specifying Run Settings}, {Use Qt Creator variables} {Configure projects for running}, {Use Qt Creator variables}
*/ */
/*! /*!
@@ -144,6 +144,6 @@
To temporarily disable a variable, add a hash character (#) to the beginning To temporarily disable a variable, add a hash character (#) to the beginning
of the line. of the line.
\sa {Specify the environment for projects}, {Specifying Build Settings}, \sa {Specify the environment for projects}, {Configure projects for building},
{Use Qt Creator variables} {Configure projects for running}, {Use Qt Creator variables}
*/ */

47
doc/qtcreator/src/projects/creator-only/creator-projects-settings-overview.qdoc
View File

@@ -30,6 +30,49 @@
To specify build or run settings for a kit, select \uicontrol Build or To specify build or run settings for a kit, select \uicontrol Build or
\uicontrol Run below the kit name. \uicontrol Run below the kit name.
\section1 Specifying Build Settings
\image qtcreator-build-configurations.png {Build configurations}
Different build configurations allow you to quickly switch between
different build settings. By default, \QC creates the following
configurations:
\list
\li Debug
\li Release
\li Profile
\endlist
A debug build has debug symbols that you need for debugging the application
but that you can leave out from the release version. Generally, you use the
debug configuration for testing and the release configuration for creating
the final installation binary package.
If you selected CMake as the build system for the project, you can
use a \e {minimum size release} build configuration to create the
final installation binary package. It is a release build that makes the size
of the binary package as small as possible, even if this makes the
application slower.
A profile build (which is called \e {release with debug information}
when using CMake) is an optimized release build that is delivered
with separate debug information. It is best suited for analyzing
applications.
\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.
\QC automatically creates deploy and run configurations for your project.
\image qtcreator-settings-run-desktop.webp {Run Settings}
To prevent \QC from automatically creating run configurations, select
\preferences > \uicontrol {Build & Run}, and then deselect the
\uicontrol {Create suitable run configurations automatically} check box.
\section1 Overriding Global Preferences \section1 Overriding Global Preferences
In \uicontrol {Project Settings}, you can override global preferences for In \uicontrol {Project Settings}, you can override global preferences for
@@ -52,8 +95,8 @@
If you have multiple projects open in \QC, select the project to configure If you have multiple projects open in \QC, select the project to configure
in \uicontrol {Active Project}. in \uicontrol {Active Project}.
\sa {Activate kits for a project}, {Open projects}, \sa {Activate kits for a project}, {Configure projects for building},
{Specifying Build Settings}, {Specifying Run Settings} {Configure projects for running}, {Open projects}
*/ */
/*! /*!

34
doc/qtcreator/src/projects/creator-only/creator-projects-settings-run-analyze.qdocinc → doc/qtcreator/src/projects/creator-only/creator-projects-settings-run-analyze.qdoc
View File

@@ -1,17 +1,20 @@
// 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
/*! /*!
//! [settings valgrind] \page creator-run-settings-valgrind.html
\previouspage creator-how-tos.html
\section1 Specifying Valgrind Settings \ingroup creator-how-to-analyze
\title Specify Valgrind settings for a project
Specify settings for running applications on the \l {Kits}{Run device} that
you select for a kit in \uicontrol Projects > \uicontrol {Build & Run} >
\uicontrol Run > \uicontrol {Run Settings}.
\QC integrates \l{Analyzing Code}{Valgrind code analysis tools} for \QC integrates \l{Analyzing Code}{Valgrind code analysis tools} for
detecting memory leaks and profiling function execution. You can configure detecting memory leaks and profiling function execution.
the tools according to your needs.
You can specify Valgrind settings either globally for all projects or separately for each
project.
To specify Valgrind settings for the current project: To specify Valgrind settings for the current project:
@@ -21,7 +24,7 @@
\li Specify Valgrind settings for the project. \li Specify Valgrind settings for the project.
\image qtcreator-analyzer-settings.png "Valgrind Settings" \image qtcreator-analyzer-settings.png {Valgrind Settings}
\li In \uicontrol {Valgrind executable}, specify the path to the \li In \uicontrol {Valgrind executable}, specify the path to the
Valgrind executable. Valgrind executable.
@@ -35,20 +38,11 @@
\endlist \endlist
For more information about the Callgrind and Memcheck settings, see:
\list
\li \l{Selecting Profiling Options}
\li \l{Selecting Options for Memory Analysis}
\endlist
Click \uicontrol {Restore Global} to revert to the global settings. Click \uicontrol {Restore Global} to revert to the global settings.
To specify global Valgrind settings, select \preferences > To specify global Valgrind settings, select \preferences >
\uicontrol Analyzer. \uicontrol Analyzer.
//! [settings valgrind] \sa {Configuring Projects}, {Selecting Options for Memory Analysis},
{Selecting Profiling Options}, {Using Valgrind Code Analysis Tools}
*/ */

18
doc/qtcreator/src/projects/creator-only/creator-projects-settings-run-debug.qdocinc → doc/qtcreator/src/projects/creator-only/creator-projects-settings-run-debug.qdoc
View File

@@ -2,11 +2,19 @@
// 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
/*! /*!
//! [run settings debugger] \page creator-how-to-enble-debugging.html
\previouspage creator-how-tos.html
\section1 Enabling Debugging \ingroup creator-how-to-projects
\ingroup creator-how-to-build
\image qtquick-debugger-settings.webp "Debugger Settings" \title Enable debugging
Specify settings for running applications on the \l {Kits}{Run device} that
you select for a kit in \uicontrol Projects > \uicontrol {Build & Run} >
\uicontrol Run > \uicontrol {Run Settings}.
\image qtquick-debugger-settings.webp {Debugger Settings"}
To select the languages to debug, select \uicontrol Automatic To select the languages to debug, select \uicontrol Automatic
or \uicontrol Enabled in \uicontrol {Debugger Settings} > or \uicontrol Enabled in \uicontrol {Debugger Settings} >
@@ -34,7 +42,5 @@
{enable QML debugging} either globally or in the \uicontrol {Build Settings} {enable QML debugging} either globally or in the \uicontrol {Build Settings}
of the project. of the project.
For more information about debugging, see \l{Debugging}. \sa {Configuring Projects}, {Debugging}
//! [run settings debugger]
*/ */

36
doc/qtcreator/src/projects/creator-only/creator-projects-settings-run-desktop.qdocinc → doc/qtcreator/src/projects/creator-only/creator-projects-settings-run-desktop.qdoc
View File

@@ -1,10 +1,23 @@
// Copyright (C) 2018 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
/*! /*!
//! [run settings desktop] \page creator-run-settings-desktop-devices.html
\previouspage creator-reference.html
\section1 Specifying Run Settings for Desktop Device Types \ingroup creator-reference-run-configurations
\title Desktop Device Run Settings
\brief Settings for running applications on desktop device types.
Specify settings for running applications on the \l {Kits}{Run device} that
you select for a kit in \uicontrol Projects > \uicontrol {Build & Run} >
\uicontrol Run > \uicontrol {Run Settings}.
\image qtcreator-settings-run-desktop.webp {Run Settings for desktop devices}
\section1 Working Directory
You can specify command-line arguments to be passed to the executable You can specify command-line arguments to be passed to the executable
and the working directory to use. The working directory defaults to and the working directory to use. The working directory defaults to
@@ -17,7 +30,7 @@
\uicontrol {Working directory} field as the installation directory in the \uicontrol {Working directory} field as the installation directory in the
\c {--install} signature. \c {--install} signature.
\image qtcreator-settings-run-desktop.webp {Run Settings} \section1 Run in Terminal
For console applications, check the \uicontrol{Run in terminal} check box. For console applications, check the \uicontrol{Run in terminal} check box.
To specify the terminal to use on Linux and \macos, select \preferences > To specify the terminal to use on Linux and \macos, select \preferences >
@@ -25,9 +38,7 @@
{internal terminal}, select \preferences > \uicontrol Terminal > {internal terminal}, select \preferences > \uicontrol Terminal >
\uicontrol {Use internal terminal}. \uicontrol {Use internal terminal}.
To run with special environment variables set up, select them in the \section1 Linker Libraries
\uicontrol {Run Environment} section. For more information, see
\l {Specify the run environment}.
When building an application, \QC creates a list of directories where the When building an application, \QC creates a list of directories where the
linker will look for libraries that the application links to. By linker will look for libraries that the application links to. By
@@ -43,17 +54,18 @@
\uicontrol {Build & Run}, and then deselect the \uicontrol {Build & Run}, and then deselect the
\uicontrol {Add linker library search paths to run environment} check box. \uicontrol {Add linker library search paths to run environment} check box.
\section1 \macos Options
The \uicontrol {Use debug version of frameworks (DYLD_IMAGE_SUFFIX=_debug)} option The \uicontrol {Use debug version of frameworks (DYLD_IMAGE_SUFFIX=_debug)} option
(only available on \macos) enables you to debug (for example, step into) (only available on \macos) enables you to debug (for example, step into)
linked frameworks, such as the Qt framework itself. You do not need this linked frameworks, such as the Qt framework itself. You do not need this
option for debugging your application code. option for debugging your application code.
\section1 Linux Options
On Linux, select the \uicontrol {Run as root user} check box to run the On Linux, select the \uicontrol {Run as root user} check box to run the
application with root user permissions. application with root user permissions.
You can also create custom executable run configurations where you \sa {Configure projects for running}, {Specify a custom executable to run},
can set the executable to run. For more information, see {Specify the run environment}
\l{Specifying a Custom Executable to Run}.
//! [run settings desktop]
*/ */

86
doc/qtcreator/src/projects/creator-only/creator-projects-settings-run.qdoc
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,33 @@
// ********************************************************************** // **********************************************************************
/*! /*!
\previouspage creator-build-settings.html
\page creator-run-settings.html \page creator-run-settings.html
\nextpage creator-editor-settings.html \previouspage creator-how-tos.html
\title Specifying Run Settings \ingroup creator-how-to-projects
\ingroup creator-how-to-run
The run settings to specify depend on the type of the project and on the \title Configure projects for running
\l{glossary-buildandrun-kit}{kit} that you build and run the project with.
\QC automatically creates run configurations for your project. Specify settings for running applications on the \l {Kits}{Run device} that
To view and modify them, select \uicontrol Projects > you select for a kit in \uicontrol Projects > \uicontrol {Build & Run} >
\uicontrol {Build & Run} > \uicontrol Run. \uicontrol Run > \uicontrol {Run Settings}.
\image qtcreator-settings-run.webp {Run Settings} \image qtcreator-settings-run-desktop.webp {Run Settings}
To prevent \QC from automatically creating run configurations, select The available build settings depend on the build system that you selected
\preferences > \uicontrol {Build & Run}, for the project and the device type:
and then deselect the \uicontrol {Create suitable run configurations
automatically} check box.
\section1 Managing Run Configurations \list
\li \l {Android Run Settings}{Android}
\li \l {Boot2Qt Run Settings}{Boot2Qt}
\li \l {Desktop Device Run Settings}{Desktop}
\li \l {Python Run Settings}{Python}
\li \l {QNX Run Settings}{QNX}
\li \l {Remote Linux Run Settings}{Remote Linux}
\endlist
\section1 Manage run configurations
The available run configurations are listed in the The available run configurations are listed in the
\uicontrol {Run configuration} field. \uicontrol {Run configuration} field.
@@ -40,16 +46,18 @@
To remove the current run configuration, select \uicontrol Remove. To remove the current run configuration, select \uicontrol Remove.
\section2 qmake run configurations
The run configurations for qmake projects derive their executable from the The run configurations for qmake projects derive their executable from the
parsed .pro files. For more information on how the commands are constructed, parsed .pro files. For more information on how the commands are constructed,
see \l{Starting External Processes}. see \l{Start external processes}.
\section1 Selecting Default Run Target \section1 Select the default run target
If a project has multiple executables, you need to tell \QC which one it If a project has multiple executables, you need to tell \QC which one it
should run. should run.
\section2 CMake Run Targets \section2 CMake run targets
When using CMake, you can filter the run target list by setting When using CMake, you can filter the run target list by setting
\c qtc_runnable as the value of the \c FOLDER property \c qtc_runnable as the value of the \c FOLDER property
@@ -62,7 +70,7 @@
If you do not specify \c qtc_runnable for any project, \QC automatically If you do not specify \c qtc_runnable for any project, \QC automatically
adds run configurations for all targets specified in \c {CMakeLists.txt}. adds run configurations for all targets specified in \c {CMakeLists.txt}.
\section2 qmake Run Targets \section2 qmake run targets
When using qmake, you can prevent \QC from automatically creating run When using qmake, you can prevent \QC from automatically creating run
configurations for subprojects by specifying the \c qtc_runnable configurations for subprojects by specifying the \c qtc_runnable
@@ -82,32 +90,40 @@
For more information about qmake project templates, see \l {TEMPLATE}. For more information about qmake project templates, see \l {TEMPLATE}.
\section2 Meson Run Targets \section2 Meson run targets
\QC automatically adds run configurations for all targets declared with \QC automatically adds run configurations for all targets declared with
\c {executable()} function in Meson build descriptions. \c {executable()} function in Meson build descriptions.
\include creator-projects-settings-run-desktop.qdocinc run settings desktop \sa {Enable debugging}, {Configuring Projects},
\include creator-projects-settings-run-analyze.qdocinc settings valgrind {Specify a custom executable to run},
\include creator-projects-settings-run-debug.qdocinc run settings debugger {Specify Valgrind settings for a project},
\include creator-projects-settings-run-android.qdocinc run settings android {Run Configurations}{Reference: Run Configurations}
\include creator-projects-settings-run-linux.qdocinc run settings linux */
\include creator-projects-settings-run-qnx.qdocinc run settings qnx
\include linux-mobile/creator-projects-settings-run-b2qt.qdocinc run settings boot2qt
\section1 Specifying a Custom Executable to Run /*!
\page creator-how-to-run-custom-executables.html
\previouspage creator-how-tos.html
If you use CMake, Meson or the generic project type in \QC, or want \ingroup creator-how-to-run
\title Specify a custom executable to run
If you use \l{Setting Up Meson}{Meson} or the
\l{Setting Up a Generic Project}{generic project type}, or want
to run a custom desktop executable, create a \uicontrol {Custom Executable} to run a custom desktop executable, create a \uicontrol {Custom Executable}
run configuration for your project. For example, when working on a library, run configuration for your project. For example, when working on a library,
you can run a test application that links against the library. you can run a test application that links against the library.
Specify the executable to run, command-line arguments, working directory, To specify a custom executable to run:
and environment variables to use.
\image qmldesigner-run-custom-exe.png {Run settings for custom executables} \list 1
\li Select \uicontrol Add > \uicontrol {Custom Executable}.
\include qtquick/creator-projects-settings-run-qtquick.qdocinc run settings qt quick ui \image qtcreator-run-settings-custom-executable.webp {Run settings for custom executables}
\include python/creator-python-run.qdocinc run settings python \li In \uicontrol Executable, specify the path to the executable.
\li In \uicontrol {Command line arguments}, enter the path to the
file to run.
\endlist
\sa {Configure projects for running}
*/ */

3
doc/qtcreator/src/projects/creator-only/qtcreator-how-to-use-qtc-variables.qdoc
View File

@@ -55,5 +55,6 @@
%{variable:-default} %{variable:-default}
\endcode \endcode
\sa {Specify the environment for projects}, {Specifying Build Settings}, \sa {Specify the environment for projects}, {Configure projects for building},
{Configure projects for running}
*/ */

8
doc/qtcreator/src/projects/creator-projects-running.qdoc
View File

@@ -66,15 +66,11 @@
\image qtcreator-application-output.webp {Application Output view} \image qtcreator-application-output.webp {Application Output view}
\if defined(qtcreator)
For more information on the options you have, see
\l{Specifying Run Settings}.
\endif
\include linux-mobile/creator-projects-running-generic-linux.qdocinc running on embedded linux \include linux-mobile/creator-projects-running-generic-linux.qdocinc running on embedded linux
\if defined(qtcreator) \if defined(qtcreator)
\include qnx/creator-projects-running-qnx.qdocinc running on qnx \include qnx/creator-projects-running-qnx.qdocinc running on qnx
\include python/creator-python-run.qdocinc running python \sa {Configure projects for running}, {Run Python applications}
\endif \endif
*/ */

4
doc/qtcreator/src/python/creator-python-development.qdoc
View File

@@ -23,8 +23,8 @@
\li \l{Create a virtual environment} \li \l{Create a virtual environment}
\li \l{Use Python interactive shell} \li \l{Use Python interactive shell}
\li \l{Python Language Server} \li \l{Python Language Server}
\li \l{Running Python projects} \li \l{Run Python applications}
\li \l{Specifying Run Settings for Python Projects} \li \l{Python Run Settings}
\li \l{PDB} \li \l{PDB}
\li \l{Launching the Debugger} \li \l{Launching the Debugger}
\endlist \endlist

79
doc/qtcreator/src/python/creator-python-run-settings.qdoc Normal file
View File

@@ -0,0 +1,79 @@
// Copyright (C) 2023 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
\page creator-how-to-run-python-apps.html
\previouspage creator-how-tos.html
\ingroup creator-how-to-projects
\ingroup creator-how-to-run
\title Run Python applications
You can execute Qt for Python applications directly from \QC. If you
use the new project wizard to create the application project, the
\c main.py file is automatically executed when you select the
\uicontrol Run button.
You can specify another file to execute in the run settings of the project.
\sa {Configure projects for running}, {Create Qt for Python applications},
{Develop Qt for Python applications}, {Python Run Settings}
*/
/*!
\page creator-run-settings-python.html
\previouspage creator-reference.html
\ingroup creator-reference-run-configurations
\title Python Run Settings
\brief Settings for running Qt for Python applications.
Specify settings for running applications on the \l {Kits}{Run device} that
you select for a kit in \uicontrol Projects > \uicontrol {Build & Run} >
\uicontrol Run > \uicontrol {Run Settings}.
\image qtcreator-python-run-settings.png {Python run settings}
The following table summarizes the settings for running Qt for Python
applications.
\table
\header
\li Setting
\li Value
\row
\li \uicontrol Interpreter
\li Path to the Python executable.
\row
\li \uicontrol {Buffered output}
\li Stores the output in a buffer. This improves output performance,
but causes delays in output.
\row
\li \uicontrol Script
\li Shows the path to the main file of the project that will be run.
\row
\li \uicontrol {Command line arguments}
\li Command-line arguments to pass to the executable.
\endtable
\section1 Custom Executable Run Configuration
To run some other Python file than \c main.py, create a custom
executable run configuration:
\image qtcreator-python-run-settings-custom-executable.png {Python custom executable run configuration}
\list 1
\li Select \uicontrol Add > \uicontrol {Custom Executable}.
\li In the \uicontrol Executable field, specify the path to the
Python executable.
\li In the \uicontrol {Command line arguments} field, select
the Python file to run.
\endlist
\sa {Activate kits for a project}, {Configure projects for running},
{Create Qt for Python applications}, {Develop Qt for Python applications}
*/

54
doc/qtcreator/src/python/creator-python-run.qdocinc
View File

@@ -1,54 +0,0 @@
// Copyright (C) 2020 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
//! [running python]
\section1 Running Python Projects
You can execute Qt for Python applications directly from \QC. If you
used the \l{Use project wizards}{new project wizard}
to create the application project, the \c main.py file is automatically
executed when you select the \uicontrol Run button.
You can specify another file to execute in the
\l{Specifying Run Settings for Python Projects}{run settings}
of the project.
//! [running python]
//! [run settings python]
\section1 Specifying Run Settings for Python Projects
You can specify settings for running Qt for Python applications:
\image qtcreator-python-run-settings.png {Python run settings}
\list
\li In the \uicontrol Interpreter field, specify the path to the
Python executable.
\li Select the \uicontrol {Buffered output} check box to buffer the
output. This improves output performance, but causes delays in
output.
\li In the \uicontrol Script field, you can see the path to the
main file of the project that will be run.
\li In the \uicontrol {Command line arguments} field, specify
command-line arguments to be passed to the executable.
\endlist
If you want to run some other Python file than \c main.py, create a custom
executable run configuration:
\image qtcreator-python-run-settings-custom-executable.png
\list 1
\li Select \uicontrol Add > \uicontrol {Custom Executable}.
\li In the \uicontrol Executable field, specify the path to the
Python executable.
\li In the \uicontrol {Command line arguments} field, select
the Python file to run.
\endlist
//! [run settings python]
*/

27
doc/qtcreator/src/qnx/creator-projects-settings-run-qnx.qdoc Normal file
View File

@@ -0,0 +1,27 @@
// Copyright (C) 2023 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
\page creator-run-settings-qnx.html
\previouspage creator-reference.html
\ingroup creator-reference-run-configurations
\title QNX Run Settings
\brief Settings for running applications on Linux-based devices.
Specify settings for running applications on the \l {Kits}{Run device} that
you select for a kit in \uicontrol Projects > \uicontrol {Build & Run} >
\uicontrol Run > \uicontrol {Run Settings}.
To run and debug an application on a QNX device, you must
create connections from the development PC to the device. Select
\uicontrol {Manage device configurations} to create a connection.
Settings for QNX Neutrino devices are very similar to those for remote linux
devices.
\sa {Remote Linux Run Settings}, {Activate kits for a project},
{Configure projects for running}, {Kits}, {Connecting QNX Devices}
*/

18
doc/qtcreator/src/qnx/creator-projects-settings-run-qnx.qdocinc
View File

@@ -1,18 +0,0 @@
// Copyright (C) 2017 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
//! [run settings qnx]
\section1 Specifying Run Settings for QNX Devices
To run and debug an application on a QNX device, you must
create connections from the development PC to the device. Click
\uicontrol {Manage device configurations} to create a connection. For more
information, see \l{Connecting QNX Devices}.
Specifying run settings for QNX Neutrino devices is very similar to
\l{Specifying Run Settings for Linux-Based Devices}.
//! [run settings qnx]
*/

23
doc/qtcreator/src/qtcreator-toc.qdoc
View File

@@ -26,19 +26,6 @@
\li \l{Creating Projects} \li \l{Creating Projects}
\li \l{Configuring Projects} \li \l{Configuring Projects}
\list \list
\li \l{Specifying Build Settings}
\list
\li \l{Cmake Build Configuration}
\list
\li \l{CMake Presets}
\endlist
\li \l{qmake Build Configuration}
\li \l{Qbs Build Configuration}
\li \l{Meson Build Configuration}
\li \l{IncrediBuild Build Configuration}
\li \l{Conan Build Configuration}
\endlist
\li \l{Specifying Run Settings}
\li \l{Using Custom Output Parsers} \li \l{Using Custom Output Parsers}
\li \l{Sharing Project Settings} \li \l{Sharing Project Settings}
\endlist \endlist
@@ -182,6 +169,8 @@
\generatelist creator-how-to-build-with-cmake \generatelist creator-how-to-build-with-cmake
\li Build with qmake \li Build with qmake
\generatelist creator-how-to-build-with-qmake \generatelist creator-how-to-build-with-qmake
\li Run applications
\generatelist creator-how-to-run
\li Debug \li Debug
\generatelist creator-how-to-debug \generatelist creator-how-to-debug
\li Design UIs \li Design UIs
@@ -212,6 +201,13 @@
\list \list
\li Build Systems \li Build Systems
\generatelist creator-reference-build-systems \generatelist creator-reference-build-systems
\list
\li Build Configurations
\generatelist creator-reference-build-configurations
\li Run Configurations
\generatelist creator-reference-run-configurations
\endlist
\endlist
\li Preferences \li Preferences
\generatelist creator-reference-preferences \generatelist creator-reference-preferences
\list \list
@@ -230,5 +226,4 @@
\generatelist creator-reference-sidebar-views \generatelist creator-reference-sidebar-views
\endlist \endlist
\endlist \endlist
\endlist
*/ */

46
doc/qtcreator/src/qtquick/creator-projects-settings-run-qtquick.qdoc Normal file
View File

@@ -0,0 +1,46 @@
// Copyright (C) 2023 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
\page creator-run-settings-qtquick-ui-prototype.html
\previouspage creator-reference.html
\ingroup creator-reference-run-configurations
\title Qt Quick UI Prototype Run Settings
\brief Settings for running Qt Quick UI Prototype projects (.qmlproject).
Specify settings for running applications on the \l {Kits}{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}
in the kit.
\image qtquick-ui-prototype-run-settings.webp {Run Settings for a Qt Quick UI Prototype project}
The following table summarizes the settings for running Qt Quick UI Prototype
projects (.qmlproject).
\table
\header
\li Setting
\li Value
\row
\li \uicontrol {Override device QML Viewer}
\li \QQV to use.
\row
\li \uicontrol {Command line arguments}
\li Arguments to pass to the executable.
\row
\li \uicontrol {Main QML file}
\li File to start \QQV with.
\row
\li \uicontrol {Forward to local display}
\li Shows a remotely running X11 client on a local display.
\endtable
\sa {Qt Quick UI Projects}, {Activate kits for a project},
{Configure projects for running}, {Kits}
*/

27
doc/qtcreator/src/qtquick/creator-projects-settings-run-qtquick.qdocinc
View File

@@ -1,27 +0,0 @@
// Copyright (C) 2020 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
//! [run settings qt quick ui]
\section1 Specifying Run Settings for Qt Quick UI Projects
You can specify run settings for \l{glossary-buildandrun-kit}{kits}
with \uicontrol Desktop device type:
\list
\li In the \uicontrol {QML Viewer} field, specify the \QQV to use.
\li In the \uicontrol {Command line arguments} field, specify arguments
to be passed to the executable.
\li In the \uicontrol {Main QML file}, select the file that \QQV will be
started with.
\endlist
\image qmldesigner-run-settings.png "Run settings for Qt Quick UI projects"
//! [run settings qt quick ui]
*/

2
doc/qtcreator/src/user-interface/creator-only/creator-how-to-switch-between-modes.qdoc
View File

@@ -55,7 +55,7 @@
\li \key Ctrl+5 \li \key Ctrl+5
\li Configure how to build and run projects. \li Configure how to build and run projects.
This mode is available when a project is open. This mode is available when a project is open.
\li \l{Specifying Build Settings} \li \l{Configuring Projects}
\row \row
\li \uicontrol Help \li \uicontrol Help
\li \key Ctrl+6 \li \key Ctrl+6

3
doc/qtcreator/src/user-interface/creator-reference-output-views.qdoc
View File

@@ -121,8 +121,7 @@
\if defined(qtcreator) \if defined(qtcreator)
If you specify command-line arguments in the run settings that are passed If you specify command-line arguments in the run settings that are passed
to the application when running it, they are displayed as a part of the to the application when running it, they are displayed as a part of the
application output. For more information, see application output. For more information, see \l{Desktop Device Run Settings}.
\l{Specifying Run Settings for Desktop Device Types}.
\endif \endif
Select toolbar buttons to run applications, to attach the debugger to the Select toolbar buttons to run applications, to attach the debugger to the