diff --git a/doc/config/qtcreator-project.qdocconf b/doc/config/qtcreator-project.qdocconf index 58fceb2740b..b43166e8ad7 100644 --- a/doc/config/qtcreator-project.qdocconf +++ b/doc/config/qtcreator-project.qdocconf @@ -20,7 +20,8 @@ imagedirs = ../images \ ../../src/plugins/qmldesigner/components/formeditor \ ../../src/plugins/qmldesigner/components/navigator \ ../../src/plugins/scxmleditor/common/images \ - ../../src/plugins/texteditor/images + ../../src/plugins/texteditor/images \ + ../../src/plugins/valgrind/images exampledirs = ../examples examples.fileextensions += *.qml *.svg diff --git a/doc/images/qtcreator-analyzer-settings.png b/doc/images/qtcreator-analyzer-settings.png index ce321e520a8..2097cb24691 100644 Binary files a/doc/images/qtcreator-analyzer-settings.png and b/doc/images/qtcreator-analyzer-settings.png differ diff --git a/doc/images/qtcreator-valgrind-callgrind-options.png b/doc/images/qtcreator-valgrind-callgrind-options.png index eb7956c57b8..82684f645b9 100644 Binary files a/doc/images/qtcreator-valgrind-callgrind-options.png and b/doc/images/qtcreator-valgrind-callgrind-options.png differ diff --git a/doc/images/qtcreator-valgrind-callgrind.png b/doc/images/qtcreator-valgrind-callgrind.png index 34396a56633..e57038a1517 100755 Binary files a/doc/images/qtcreator-valgrind-callgrind.png and b/doc/images/qtcreator-valgrind-callgrind.png differ diff --git a/doc/src/analyze/creator-valgrind.qdoc b/doc/src/analyze/creator-valgrind.qdoc index fb22f8632c6..92c42fd48c9 100644 --- a/doc/src/analyze/creator-valgrind.qdoc +++ b/doc/src/analyze/creator-valgrind.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2018 The Qt Company Ltd. +** Copyright (C) 2019 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the Qt Creator documentation. @@ -149,13 +149,17 @@ You can use the Callgrind tool included in the \l{http://valgrind.org/info/tools.html}{Valgrind tool suite} to detect - problems that are related to executing functions. + problems that are related to executing functions. In addition, you + can load the data files generated by Callgrind into the + \l{https://kcachegrind.github.io/html/Home.html}{KCachegrind} + profile data visualization tool for browsing the performance results. - After you download and install Valgrind tools, you can use Callgrind from - \QC. + After you download and install Valgrind tools and KCachegrind, you can use + Callgrind and KCachegrind from \QC. - \note You can install and run Callgrind locally on Linux. You can run - it on a remote Linux machine or device from any development machine. + \note You can install and run Callgrind and KCachegrind locally on Linux. + You can run Callgrind on a remote Linux machine or device from any + development machine. To analyze applications: @@ -207,6 +211,10 @@ \image qtcreator-valgrind-callgrind.png "Profile view" + To view the data in KCachegrind, select the \inlineimage kcachegrind.png + (\uicontrol {Open Results in KCachegrind}) button on the toolbar. \QC + launches KCachegrind and loads the data into it for visualization. + \section1 Selecting Profiling Options You can specify analyzer settings either globally for all projects or @@ -218,6 +226,9 @@ \image qtcreator-valgrind-callgrind-options.png "Valgrind options" + In the \uicontrol {KCachegrind executable} field, enter the path to the + KCachegrind executable to launch. + In the \uicontrol {Result view: Minimum event cost} field, limit the amount of results the profiler gives you to increase profiler performance.