diff options
author | Eike Ziller <eike.ziller@qt.io> | 2024-03-21 13:24:06 +0100 |
---|---|---|
committer | Eike Ziller <eike.ziller@qt.io> | 2024-03-22 08:51:44 +0000 |
commit | ff08e30b0a67fb65bda574ce4cde5dc57afe3992 (patch) | |
tree | 55dd0df8ff4121e4494adb22d7a2263860dbd91e | |
parent | 36a00855bb7236be8c4fb1199bb03d8c6603dc80 (diff) |
Doc: Improve the description of default build configurations
- 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>
-rw-r--r-- | doc/qtcreator/src/projects/creator-only/creator-projects-settings-overview.qdoc | 21 |
1 files changed, 11 insertions, 10 deletions
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 ad28fffa57..93510fa438 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 @@ -45,22 +45,23 @@ \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 + A \e Debug build has debug symbols that you need for debugging the application + but that you should leave out from the release version. Generally, you use the + debug configuration for testing and the \e 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 + A \e Profile build is an optimized release build with debug information. + 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 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 |