llvm-profdata.1   [plain text]


.\" Man page generated from reStructuredText.
.
.TH "LLVM-PROFDATA" "1" "2016-02-05" "clang-703" "LLVM"
.SH NAME
llvm-profdata \- Profile data tool
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH SYNOPSIS
.sp
\fBllvm\-profdata\fP \fIcommand\fP [\fIargs...\fP]
.SH DESCRIPTION
.sp
The \fBllvm\-profdata\fP tool is a small utility for working with profile
data files.
.SH COMMANDS
.INDENT 0.0
.IP \(bu 2
\fI\%merge\fP
.IP \(bu 2
\fI\%show\fP
.UNINDENT
.SH MERGE
.SS SYNOPSIS
.sp
\fBllvm\-profdata merge\fP [\fIoptions\fP] [\fIfilenames...\fP]
.SS DESCRIPTION
.sp
\fBllvm\-profdata merge\fP takes several profile data files
generated by PGO instrumentation and merges them together into a single
indexed profile data file.
.SS OPTIONS
.INDENT 0.0
.TP
.B \-help
Print a summary of command line options.
.UNINDENT
.INDENT 0.0
.TP
.B \-output=output, \-o=output
Specify the output file name.  \fIOutput\fP cannot be \fB\-\fP as the resulting
indexed profile data can\(aqt be written to standard output.
.UNINDENT
.INDENT 0.0
.TP
.B \-instr (default)
Specify that the input profile is an instrumentation\-based profile.
.UNINDENT
.INDENT 0.0
.TP
.B \-sample
Specify that the input profile is a sample\-based profile. When using
sample\-based profiles, the format of the generated file can be generated
in one of three ways:
.INDENT 7.0
.TP
.B \-binary (default)
.UNINDENT
.sp
Emit the profile using a binary encoding.
.INDENT 7.0
.TP
.B \-text
.UNINDENT
.sp
Emit the profile in text mode.
.INDENT 7.0
.TP
.B \-gcc
.UNINDENT
.sp
Emit the profile using GCC\(aqs gcov format (Not yet supported).
.UNINDENT
.SH SHOW
.SS SYNOPSIS
.sp
\fBllvm\-profdata show\fP [\fIoptions\fP] [\fIfilename\fP]
.SS DESCRIPTION
.sp
\fBllvm\-profdata show\fP takes a profile data file and displays the
information about the profile counters for this file and
for any of the specified function(s).
.sp
If \fIfilename\fP is omitted or is \fB\-\fP, then \fBllvm\-profdata show\fP reads its
input from standard input.
.SS OPTIONS
.INDENT 0.0
.TP
.B \-all\-functions
Print details for every function.
.UNINDENT
.INDENT 0.0
.TP
.B \-counts
Print the counter values for the displayed functions.
.UNINDENT
.INDENT 0.0
.TP
.B \-function=string
Print details for a function if the function\(aqs name contains the given string.
.UNINDENT
.INDENT 0.0
.TP
.B \-help
Print a summary of command line options.
.UNINDENT
.INDENT 0.0
.TP
.B \-output=output, \-o=output
Specify the output file name.  If \fIoutput\fP is \fB\-\fP or it isn\(aqt specified,
then the output is sent to standard output.
.UNINDENT
.INDENT 0.0
.TP
.B \-instr (default)
Specify that the input profile is an instrumentation\-based profile.
.UNINDENT
.INDENT 0.0
.TP
.B \-sample
Specify that the input profile is a sample\-based profile.
.UNINDENT
.SH EXIT STATUS
.sp
\fBllvm\-profdata\fP returns 1 if the command is omitted or is invalid,
if it cannot read input files, or if there is a mismatch between their data.
.SH AUTHOR
Maintained by The LLVM Team (http://llvm.org/).
.SH COPYRIGHT
2003-2016, LLVM Project
.\" Generated by docutils manpage writer.
.