aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTeea Poldsam <[email protected]>2025-09-11 11:59:05 +0300
committerTeea Põldsam <[email protected]>2025-09-15 07:15:05 +0000
commitc5e58db9c194f668263556109ad9be0fb7705b46 (patch)
treeec04bdb389ae66a068087c2470045077c955ca22
parent09012de705c802eaa7463b2bb5a1dc2bc9bdf159 (diff)
Doc: Describe the Building and Running settings
Task-number: QTCREATORBUG-33078 Change-Id: I170d856d49e9427f1aa33c5e11d8df251592a7d3 Reviewed-by: Leena Miettinen <[email protected]> Reviewed-by: Christian Kandeler <[email protected]>
-rw-r--r--doc/qtcreator/images/qtcreator-projects-building-and-running-settings.webpbin0 -> 6612 bytes
-rw-r--r--doc/qtcreator/src/projects/creator-only/creator-projects-settings-building-and-running.qdoc74
-rw-r--r--doc/qtcreator/src/projects/creator-only/creator-projects-settings-overview.qdoc1
3 files changed, 75 insertions, 0 deletions
diff --git a/doc/qtcreator/images/qtcreator-projects-building-and-running-settings.webp b/doc/qtcreator/images/qtcreator-projects-building-and-running-settings.webp
new file mode 100644
index 00000000000..d66d654b161
--- /dev/null
+++ b/doc/qtcreator/images/qtcreator-projects-building-and-running-settings.webp
Binary files differ
diff --git a/doc/qtcreator/src/projects/creator-only/creator-projects-settings-building-and-running.qdoc b/doc/qtcreator/src/projects/creator-only/creator-projects-settings-building-and-running.qdoc
new file mode 100644
index 00000000000..f463f746767
--- /dev/null
+++ b/doc/qtcreator/src/projects/creator-only/creator-projects-settings-building-and-running.qdoc
@@ -0,0 +1,74 @@
+// Copyright (C) 2025 The Qt Company Ltd.
+// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
+
+// **********************************************************************
+// NOTE: the sections are not ordered by their logical order to avoid
+// reshuffling the file each time the index order changes (i.e., often).
+// Run the fixnavi.pl script to adjust the links to the index order.
+// **********************************************************************
+
+/*!
+ \page creator-building-running-settings.html
+ \previouspage creator-how-tos.html
+
+ \ingroup creator-how-to-projects-configure
+
+ \title Specify build and run settings
+
+ To override the build and run settings for the current project:
+
+ \list 1
+
+ \li Go to \uicontrol Projects > \uicontrol {Project Settings} >
+ \uicontrol {Building and Running}.
+
+ \image {qtcreator-projects-building-and-running-settings.webp} {Building and Running settings in the Projects mode}
+
+ \li Clear \uicontrol {Use global settings}.
+
+ \li Specify build and run settings for the project.
+
+ \endlist
+
+ Your choices override some of the values you set in \preferences >
+ \uicontrol {Build & Run} > \uicontrol General.
+
+ \table
+ \header
+ \li Setting
+ \li Value
+ \row
+ \li Add linker library search paths to run environment
+ \li Ensures that library paths used during linking are also available
+ when running the application.
+ \row
+ \li Create suitable run configurations automatically
+ \li Automatically generates run configurations based on the current
+ build settings.
+ \row
+ \li Start build processes with low priority
+ \li Launches build processes with a lower priority.
+ \row
+ \li Warn against build directories with spaces or non-ASCII characters
+ \li Displays warnings if the build directory contains spaces or
+ non-standard characters that may cause issues.
+ \row
+ \li Default for "Run in terminal"
+ \li Specifies whether applications should run in a terminal by default.
+ \row
+ \li Keep run configurations in sync
+ \li Specifies whether adding, removing, or editing a run configuration
+ in one build configuration should update other build configurations
+ accordingly.
+ \row
+ \li Time to wait before force-stopping applications
+ \li Specifies the number of seconds to wait between a \e {soft kill} and a
+ \e {hard kill} of a running application.
+ \endtable
+
+
+ Select \uicontrol {Restore Global} to revert to the global settings.
+
+ \sa {Build and Run}
+
+*/
diff --git a/doc/qtcreator/src/projects/creator-only/creator-projects-settings-overview.qdoc b/doc/qtcreator/src/projects/creator-only/creator-projects-settings-overview.qdoc
index f88c1cd6838..b941c513fe2 100644
--- a/doc/qtcreator/src/projects/creator-only/creator-projects-settings-overview.qdoc
+++ b/doc/qtcreator/src/projects/creator-only/creator-projects-settings-overview.qdoc
@@ -84,6 +84,7 @@
the project:
\list
+ \li \l{Specify building and running settings}{Building and Running}
\li \l{Specify Clang tools settings}{Clang Tools}
\li \l{Specify clangd settings}{Clangd}
\li \l{Override CMake settings for a project}{CMake}