.\" Man page generated from reStructuredText.
.
.
.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
..
.TH "LLVM-REMARKUTIL" "1" "2024-02-05" "15" "LLVM"
.SH NAME
llvm-remarkutil \- Remark utility
.SH SYNOPSIS
.sp
\fBllvm\-remarkutil\fP [\fIsubcommmand\fP] [\fIoptions\fP]
.SH DESCRIPTION
.sp
Utility for displaying information from, and converting between different
\fI\%remark\fP formats.
.SH SUBCOMMANDS
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
\fI\%bitstream2yaml\fP \- Reserialize bitstream remarks to YAML.
.IP \(bu 2
\fI\%yaml2bitstream\fP \- Reserialize YAML remarks to bitstream.
.IP \(bu 2
\fI\%instruction\-count\fP \- Output function instruction counts.
.IP \(bu 2
\fI\%annotation\-count\fP \- Output remark type count from annotation remarks.
.UNINDENT
.UNINDENT
.UNINDENT
.SS bitstream2yaml
.sp
USAGE: \fBllvm\-remarkutil\fP bitstream2yaml <input file> \-o <output file>
.SS Summary
.sp
Takes a bitstream remark file as input, and reserializes that file as YAML.
.SS yaml2bitstream
.sp
USAGE: \fBllvm\-remarkutil\fP yaml2bitstream <input file> \-o <output file>
.SS Summary
.sp
Takes a YAML remark file as input, and reserializes that file in the bitstream
format.
.SS instruction\-count
.sp
USAGE: \fBllvm\-remarkutil\fP instruction\-count <input file> –parser=<bitstream|yaml> [–use\-debug\-loc] \-o <output file>
.SS Summary
.sp
Outputs instruction count remarks for every function. Instruction count remarks
encode the number of instructions in a function at assembly printing time.
.sp
Instruction count remarks require asm\-printer remarks.
.sp
CSV format is as follows:
.INDENT 0.0
.TP
.B ::
Function,InstructionCount
foo,123
.UNINDENT
.sp
if \fI–use\-debug\-loc\fP is passed then the CSV will include the source path, line number and column.
.INDENT 0.0
.TP
.B ::
Source,Function,InstructionCount
path:line:column,foo,3
.UNINDENT
.SS annotation\-count
.sp
USAGE: \fBllvm\-remarkutil\fP annotation\-count <input file> –parser=<bitstream|yaml> –annotation\-type=<type>  [–use\-debug\-loc] \-o <output file>
.SS Summary
.sp
Outputs a count for annotation\-type \fI<type>\fP remark for every function. The count expresses
the number of remark checks inserted at the function.
.sp
Annotation count remarks require AnnotationRemarksPass remarks.
.sp
CSV format is as follows:
.INDENT 0.0
.TP
.B ::
Function,Count
foo,123
.UNINDENT
.sp
if \fI–use\-debug\-loc\fP is passed then the CSV will include the source path, line number and column.
.INDENT 0.0
.TP
.B ::
Source,Function,Count
path:line:column,foo,3
.UNINDENT
.SH AUTHOR
Maintained by the LLVM Team (https://llvm.org/).
.SH COPYRIGHT
2003-2024, LLVM Project
.\" Generated by docutils manpage writer.
.