diff options
author | Leena Miettinen <riitta-leena.miettinen@qt.io> | 2024-02-13 14:12:14 +0100 |
---|---|---|
committer | Leena Miettinen <riitta-leena.miettinen@qt.io> | 2024-02-19 12:33:32 +0000 |
commit | 5a05044c0c037905a85a11961be1cb5776195817 (patch) | |
tree | 7907fdc632cc87fcb2f4a5565279b5f2d6c19c34 /doc/qtcreator/src/projects | |
parent | c28a388b1f6259686c625cd285588c7ecad9e5af (diff) |
Doc: Turn Customizing the Build Process into a how-to topic
- Update the screenshot of Preferences > Build & Run > General
(there is a new option that will be described in another
change)
Task-number: QTCREATORBUG-29361
Task-number: QTCREATORBUG-30209
Change-Id: I62eaeef96b2d40dfec42022a4430da15c1590050
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
Diffstat (limited to 'doc/qtcreator/src/projects')
3 files changed, 34 insertions, 41 deletions
diff --git a/doc/qtcreator/src/projects/creator-only/creator-projects-building-running.qdoc b/doc/qtcreator/src/projects/creator-only/creator-projects-building-running.qdoc index 32f2fdc5880..3f54c09e1a3 100644 --- a/doc/qtcreator/src/projects/creator-only/creator-projects-building-running.qdoc +++ b/doc/qtcreator/src/projects/creator-only/creator-projects-building-running.qdoc @@ -37,15 +37,6 @@ the sources into binaries. Build configurations use the tools and settings defined in their corresponding kit. - \li \l{Run on many platforms} - - \e {Run configurations} start the application in the location - where it was copied by the \e{deploy configuration}. By default, - when you select the \uicontrol Run function, \QC builds the project, - deploys it to the device defined in the kit, and runs it there. However, - if you have not made any changes to the project since you last - built and deployed it, \QC simply runs it again. - \li \l{Deploying to Devices} \e {Deploy configurations} handle the packaging and copying of @@ -63,16 +54,5 @@ \endlist - \section1 Related Topics - - \list - - \li \l{Customizing the Build Process} - - By default, running an application also builds it and deploys it to - a location from where it can be run on the device. You can change - the relationship between the build, run, and deploy configurations. - - \endlist - + \sa {Build and Run}{How To: Build and Run} */ diff --git a/doc/qtcreator/src/projects/creator-only/creator-projects-builds-customizing.qdoc b/doc/qtcreator/src/projects/creator-only/creator-projects-builds-customizing.qdoc index 48f1bf87611..15156c42014 100644 --- a/doc/qtcreator/src/projects/creator-only/creator-projects-builds-customizing.qdoc +++ b/doc/qtcreator/src/projects/creator-only/creator-projects-builds-customizing.qdoc @@ -1,4 +1,4 @@ -// Copyright (C) 2020 The Qt Company Ltd. +// Copyright (C) 2024 The Qt Company Ltd. // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only // ********************************************************************** @@ -9,35 +9,48 @@ /*! \page creator-build-process-customizing.html - \previouspage creator-setup-webassembly.html - \nextpage creator-testing.html + \previouspage creator-how-tos.html - \title Customizing the Build Process + \ingroup creator-how-to-build - To configure how projects are built, deployed, and run, select + \title Customize the build process + + To configure how projects are built, deployed, and run, go to \preferences > \uicontrol {Build & Run} > \uicontrol General. - \image qtcreator-project-options-deploy.png "Project General preferences" + \image qtcreator-preferences-build-run-general.webp {Build & Run General preferences} - By default, the \uicontrol {Always deploy project before running it} (1) and - \uicontrol {Build the Whole Project} (2) options are enabled. Therefore, - when you select the \uicontrol Run function, \QC checks for changes in the - project files and also builds and deploys the project if necessary. + By default, \uicontrol {Always deploy project before running it} (1) and + \uicontrol {Build the Whole Project} (2) are selected. Therefore, when + you select \inlineimage icons/run_small.png (\uicontrol Run), \QC checks + for changes in the project files and also builds and deploys the project if + necessary. To deploy applications without building them or to just build the application that you want to run, select the appropriate options - in the \uicontrol {Build before deploying} field. + in \uicontrol {Build before deploying}. + + \section1 Stop applications before building By default, the applications that the project contains are stopped - before rebuilding the project. To stop just the current application, - the applications in the same build directory, all applications, - or no applications, select the appropriate option in the - \uicontrol {Stop applications before building} field. + before rebuilding the project. + + To stop just the current application, the applications in the same build + directory, all applications, or no applications, select the appropriate + option in \uicontrol {Stop applications before building}. + + \section1 Use jom On Windows, you can use \c jom instead of \c nmake for building the project - to distribute the compilation process to multiple CPU cores. You can download - \c jom from \l{http://download.qt.io/official_releases/jom}{Qt Downloads}. - To use \c jom, select the \uicontrol {Use jom instead of nmake} check box. - Deselect the check box if you experience build problems. + to distribute the compilation process to multiple CPU cores. + + To use \c jom: + + \list 1 + \li Download \c jom from \l{http://download.qt.io/official_releases/jom} + {Qt Downloads}. + \li Select \uicontrol {Use jom instead of nmake}. + \endlist + Clear the check box if builds fail. */ diff --git a/doc/qtcreator/src/projects/creator-projects-running.qdoc b/doc/qtcreator/src/projects/creator-projects-running.qdoc index 80eb0650e4e..43d80f08c8d 100644 --- a/doc/qtcreator/src/projects/creator-projects-running.qdoc +++ b/doc/qtcreator/src/projects/creator-projects-running.qdoc @@ -78,7 +78,7 @@ the application has large image files that would need to be bundled into the resource file before running the application. - \sa {Configure projects for running}, {Customizing the Build Process}, + \sa {Configure projects for running}, {Customize the build process}, {Run on QNX devices}, {Run on remote Linux devices}, {Run Python applications}, {Supported Platforms} */ |