summaryrefslogtreecommitdiff
path: root/doc/src/analyze/creator-valgrind-overview.qdoc
blob: 561a1c02198130bd7cdaef5fadd36cd2a749f857 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
/****************************************************************************
**
** Copyright (c) 2014 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of Qt Creator
**
**
** GNU Free Documentation License
**
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of this
** file.
**
**
****************************************************************************/

// **********************************************************************
// 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.
// **********************************************************************

/*!
    \contentspage {Qt Creator Manual}
    \previouspage creator-qml-performance-monitor.html
    \page creator-valgrind-overview.html
    \nextpage creator-analyzer.html

    \title Using Valgrind Code Analysis Tools

    \QC integrates \l{http://valgrind.org/info/tools.html}{Valgrind code
    analysis tools} for detecting memory leaks and
    profiling function execution. You must download and install them separately
    to use them from \QC.

    To run the Valgrind tools on a remote host over SSH, select \gui {Analyze
    > Valgrind Memory Analyzer (Remote)} or \gui {Valgrind Function Profiler
    (Remote)}.

    To stop the currently running analyzer, select \gui {Analyze
    > Stop}.

    To select options for the Valgrind tools, select \gui {Tools > Options >
    Analyzer}. You can override the general settings for each project in the
    \gui {Run Settings} for the project.

    The following sections describe how to use the Valgrind tools:

    \list

        \li \l{Detecting Memory Leaks}

        \li \l{Profiling Function Execution}

        \li \l{Running Valgrind Tools Remotely}

    \endlist

*/