Documentation for llvm-cov: reformat
[oota-llvm.git] / docs / CommandGuide / llvm-cov.rst
1 llvm-cov - emit coverage information
2 ====================================
3
4 SYNOPSIS
5 --------
6
7 :program:`llvm-cov` [-gcno=filename] [-gcda=filename] [dump]
8
9 DESCRIPTION
10 -----------
11
12 The experimental :program:`llvm-cov` tool reads in description file generated
13 by compiler and coverage data file generated by instrumented program.  This
14 program assumes that the description and data file uses same format as gcov
15 files.
16
17 OPTIONS
18 -------
19
20 .. option:: -gcno=filename
21
22  This option selects input description file generated by compiler while
23  instrumenting program.
24
25 .. option:: -gcda=filename
26
27  This option selects coverage data file generated by instrumented compiler.
28
29 .. option:: -dump
30
31  This options enables output dump that is suitable for a developer to help
32  debug :program:`llvm-cov` itself.
33
34 EXIT STATUS
35 -----------
36
37 :program:`llvm-cov` returns 1 if it cannot read input files.  Otherwise, it
38 exits with zero.
39