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

Doc: Improve the description of default build configurations

Browse Source 
- Consistently use emphasis and case for configuration names
- Do not promise *separate* debug information for "Profile". CMake
  doesn't have that option
- Add information about "Release with Debug Information" for CMake and
  the difference to "Profile"

Fixes: QTCREATORBUG-30581
Change-Id: Idd53b11d3dd45121a34a41f12e48ea5339fd61c1
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
This commit is contained in:
Eike Ziller
2024-03-21 13:24:06 +01:00
parent 36a00855bb
commit ff08e30b0a
1 changed files with 11 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -45,22 +45,23 @@
\li Profile \li Profile
\endlist \endlist
A debug build has debug symbols that you need for debugging the application A \e 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 but that you should leave out from the release version. Generally, you use the
debug configuration for testing and the release configuration for creating debug configuration for testing and the \e Release configuration for creating
the final installation binary package. the final installation binary package.
If you selected CMake as the build system for the project, you can A \e Profile build is an optimized release build with debug information.
use a \e {minimum size release} build configuration to create the It is best suited for analyzing applications.
If you selected CMake as the build system for the project, a
\e {Release with Debug Information} build configuration is also available.
It is similar to a \e profile configuration, but with
\l{Debugging Qt Quick Projects}{QML debugging and profiling} explicitly turned off.
You can also use a \e {Minimum Size Release} build configuration to create the
final installation binary package. It is a release build that makes the size 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 of the binary package as small as possible, even if this makes the
application slower. 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 \section1 Specifying Run Settings
The run settings to specify depend on the type of the project and on the The run settings to specify depend on the type of the project and on the