Add "profiling" build variant

Also known as "release-with-debug-info"

Change-Id: Ieed358810ea423ea7a9a1a52a36fa35cf165dfac
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>

2 files changed, 20 insertions, 8 deletions

diff --git a/doc/howtos.qdoc b/doc/howtos.qdoc
index 9512cb0a9..61da7af53 100644
--- a/doc/howtos.qdoc
+++ b/doc/howtos.qdoc
@@ -37,6 +37,7 @@
     \list
     \li \l{How do I build a Qt-based project?}
     \li \l{How do I make my app build against my library?}
+    \li \l{How do I build release with debug information?}
     \li \l{How do I separate and install debugging symbols?}
     \li \l{How do I use precompiled headers?}
     \li \l{How do I make sure my generated sources are getting compiled?}
@@ -130,6 +131,13 @@
     }
     \endcode
 
+    \section1 How do I build release with debug information?
+
+    You can simply use the \c{"profiling"} \l{qbs::buildVariant}{qbs.buildVariant}:
+    \code
+    qbs build qbs.buildVariant:profiling
+    \endcode
+
     \section1 How do I separate and install debugging symbols?
 
     First, you need to set the \l{cpp::debugInformation}{cpp.debugInformation} and
diff --git a/doc/reference/modules/qbs-module.qdoc b/doc/reference/modules/qbs-module.qdoc
index dfc53c63d..e24eef676 100644
--- a/doc/reference/modules/qbs-module.qdoc
+++ b/doc/reference/modules/qbs-module.qdoc
@@ -113,11 +113,13 @@
 
     The name of the build variant for the current build.
 
-    Possible values are \c{"debug"} and \c{"release"}. A debug build usually
-    contains additional debug symbols that are needed for debugging the
-    application but that can be left out from the release version. Debug builds
-    are used for testing and release builds for creating the final installation
-    file.
+    Possible values are \c{"debug"}, \c{"release"} and \c{"profiling"}.
+    A debug build usually contains additional debug symbols that are needed for
+    debugging the application and has optimizations turned off. A profiling
+    build usually contains debug symbols and has optimizations turned on. This
+    is useful for profiling tools or when you need to retain debug symbols
+    in a release build. A release build is a build without debug information and
+    with optimizations enabled.
 
     \defaultvalue \c{"release"} if
     \l{qbs::configurationName}{qbs.configurationName} is \c{"release"}. Otherwise
@@ -129,7 +131,8 @@
 
     Whether to generate debug information.
 
-    \defaultvalue \c{true} for debug builds, \c{false} otherwise.
+    \defaultvalue \c{true} if \l{qbs::buildVariant}{qbs.buildVariant} is \c{"debug"} or
+    \c{"profiling"}. Otherwise \c{false}.
 */
 
 /*!
@@ -151,7 +154,7 @@
     \endlist
 
     Typically, this property is enabled for debug builds and disabled for
-    release builds.
+    release or profiling builds.
 
     \defaultvalue \c{true} for debug builds, \c{false} otherwise.
 */
@@ -169,7 +172,8 @@
         \li \c{"small"}
     \endlist
 
-    \defaultvalue \c{"none"} for debug builds, \c{"fast"} for release builds.
+    \defaultvalue \c{"none"} if \l{qbs::buildVariant}{qbs.buildVariant} is \c{"debug"}.
+    Otherwise \c{"fast"}.
 */
 
 /*!