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