Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / valgrind / refs/tags/21.01.0-rel.0 / . / docs / callgrind_annotate.1
blob: c99fb4c0efef3b3e5219a325ce1f1e1b6c7f7953 [file] [log] [blame]
Elliott Hughesa0664b92017-04-18 17:46:52 -0700[diff] [blame]1'\" t
2.\" Title: Callgrind Annotate
3.\" Author: [see the "Author" section]
Elliott Hughesed398002017-06-21 14:41:24 -0700[diff] [blame]4.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
5.\" Date: 06/15/2017
6.\" Manual: Release 3.13.0
7.\" Source: Release 3.13.0
Elliott Hughesa0664b92017-04-18 17:46:52 -0700[diff] [blame]8.\" Language: English
9.\"
Elliott Hughesed398002017-06-21 14:41:24 -0700[diff] [blame]10.TH "CALLGRIND ANNOTATE" "1" "06/15/2017" "Release 3.13.0" "Release 3.13.0"
Elliott Hughesa0664b92017-04-18 17:46:52 -0700[diff] [blame]11.\" -----------------------------------------------------------------
12.\" * Define some portability stuff
13.\" -----------------------------------------------------------------
14.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15.\" http://bugs.debian.org/507673
16.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18.ie \n(.g .ds Aq \(aq
19.el .ds Aq '
20.\" -----------------------------------------------------------------
21.\" * set default formatting
22.\" -----------------------------------------------------------------
23.\" disable hyphenation
24.nh
25.\" disable justification (adjust text to left margin only)
26.ad l
27.\" -----------------------------------------------------------------
28.\" * MAIN CONTENT STARTS HERE *
29.\" -----------------------------------------------------------------
30.SH "NAME"
31callgrind_annotate \- post\-processing tool for the Callgrind
32.SH "SYNOPSIS"
33.HP \w'\fBcallgrind_annotate\fR\ 'u
34\fBcallgrind_annotate\fR [\fIoptions\fR] [\fIcallgrind\-out\-file\fR\ [\fIsource\-files\fR...]]
35.SH "DESCRIPTION"
36.PP
37\fBcallgrind_annotate\fR
38takes an output file produced by the Valgrind tool Callgrind and prints the information in an easy\-to\-read form\&.
39.SH "OPTIONS"
40.PP
41\fB\-h \-\-help\fR
42.RS 4
43Show summary of options\&.
44.RE
45.PP
46\fB\-\-version\fR
47.RS 4
48Show version of callgrind_annotate\&.
49.RE
50.PP
51\fB\-\-show=A,B,C [default: all]\fR
52.RS 4
53Only show figures for events A,B,C\&.
54.RE
55.PP
56\fB\-\-sort=A,B,C\fR
57.RS 4
58Sort columns by events A,B,C [event column order]\&.
Elliott Hughesed398002017-06-21 14:41:24 -0700[diff] [blame]59.sp
60Optionally, each event is followed by a : and a threshold, to specify different thresholds depending on the event\&.
Elliott Hughesa0664b92017-04-18 17:46:52 -0700[diff] [blame]61.RE
62.PP
63\fB\-\-threshold=<0\-\-100> [default: 99%] \fR
64.RS 4
65Percentage of counts (of primary sort event) we are interested in\&.
66.RE
67.PP
68\fB\-\-auto=<yes|no> [default: no] \fR
69.RS 4
70Annotate all source files containing functions that helped reach the event count threshold\&.
71.RE
72.PP
73\fB\-\-context=N [default: 8] \fR
74.RS 4
75Print N lines of context before and after annotated lines\&.
76.RE
77.PP
78\fB\-\-inclusive=<yes|no> [default: no] \fR
79.RS 4
80Add subroutine costs to functions calls\&.
81.RE
82.PP
83\fB\-\-tree=<none|caller|calling|both> [default: none] \fR
84.RS 4
85Print for each function their callers, the called functions or both\&.
86.RE
87.PP
88\fB\-I, \-\-include=<dir> \fR
89.RS 4
90Add
91\fBdir\fR
92to the list of directories to search for source files\&.
93.RE
94.SH "SEE ALSO"
95.PP
96valgrind(1),
97$INSTALL/share/doc/valgrind/html/index\&.html
98or
99http://www\&.valgrind\&.org/docs/manual/index\&.html\&.
100.SH "AUTHOR"
101.PP
102Josef Weidendorfer <Josef\&.Weidendorfer@gmx\&.de>\&.
103.PP
104This manual page was written by Philipp Frauenfelder <pfrauenf@debian\&.org>\&.