| Elliott Hughes | a0664b9 | 2017-04-18 17:46:52 -0700 | [diff] [blame] | 1 | '\" t |
| 2 | .\" Title: Callgrind Annotate |
| 3 | .\" Author: [see the "Author" section] |
| 4 | .\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/> |
| 5 | .\" Date: 10/21/2016 |
| 6 | .\" Manual: Release 3.12.0 |
| 7 | .\" Source: Release 3.12.0 |
| 8 | .\" Language: English |
| 9 | .\" |
| 10 | .TH "CALLGRIND ANNOTATE" "1" "10/21/2016" "Release 3.12.0" "Release 3.12.0" |
| 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" |
| 31 | callgrind_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 |
| 38 | takes 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 |
| 43 | Show summary of options\&. |
| 44 | .RE |
| 45 | .PP |
| 46 | \fB\-\-version\fR |
| 47 | .RS 4 |
| 48 | Show version of callgrind_annotate\&. |
| 49 | .RE |
| 50 | .PP |
| 51 | \fB\-\-show=A,B,C [default: all]\fR |
| 52 | .RS 4 |
| 53 | Only show figures for events A,B,C\&. |
| 54 | .RE |
| 55 | .PP |
| 56 | \fB\-\-sort=A,B,C\fR |
| 57 | .RS 4 |
| 58 | Sort columns by events A,B,C [event column order]\&. |
| 59 | .RE |
| 60 | .PP |
| 61 | \fB\-\-threshold=<0\-\-100> [default: 99%] \fR |
| 62 | .RS 4 |
| 63 | Percentage of counts (of primary sort event) we are interested in\&. |
| 64 | .RE |
| 65 | .PP |
| 66 | \fB\-\-auto=<yes|no> [default: no] \fR |
| 67 | .RS 4 |
| 68 | Annotate all source files containing functions that helped reach the event count threshold\&. |
| 69 | .RE |
| 70 | .PP |
| 71 | \fB\-\-context=N [default: 8] \fR |
| 72 | .RS 4 |
| 73 | Print N lines of context before and after annotated lines\&. |
| 74 | .RE |
| 75 | .PP |
| 76 | \fB\-\-inclusive=<yes|no> [default: no] \fR |
| 77 | .RS 4 |
| 78 | Add subroutine costs to functions calls\&. |
| 79 | .RE |
| 80 | .PP |
| 81 | \fB\-\-tree=<none|caller|calling|both> [default: none] \fR |
| 82 | .RS 4 |
| 83 | Print for each function their callers, the called functions or both\&. |
| 84 | .RE |
| 85 | .PP |
| 86 | \fB\-I, \-\-include=<dir> \fR |
| 87 | .RS 4 |
| 88 | Add |
| 89 | \fBdir\fR |
| 90 | to the list of directories to search for source files\&. |
| 91 | .RE |
| 92 | .SH "SEE ALSO" |
| 93 | .PP |
| 94 | valgrind(1), |
| 95 | $INSTALL/share/doc/valgrind/html/index\&.html |
| 96 | or |
| 97 | http://www\&.valgrind\&.org/docs/manual/index\&.html\&. |
| 98 | .SH "AUTHOR" |
| 99 | .PP |
| 100 | Josef Weidendorfer <Josef\&.Weidendorfer@gmx\&.de>\&. |
| 101 | .PP |
| 102 | This manual page was written by Philipp Frauenfelder <pfrauenf@debian\&.org>\&. |