blob: 524f24087f21eff13ffeaea857f982ce44f6e67d [file] [log] [blame]
Daniel Dunbar3b709d52012-05-08 16:50:35 +00001llvm-cov - emit coverage information
2====================================
3
Daniel Dunbar3b709d52012-05-08 16:50:35 +00004SYNOPSIS
5--------
6
Dmitri Gribenko90d0e7e2012-11-29 19:10:21 +00007:program:`llvm-cov` [-gcno=filename] [-gcda=filename] [dump]
Daniel Dunbar3b709d52012-05-08 16:50:35 +00008
9DESCRIPTION
10-----------
11
Dmitri Gribenko90d0e7e2012-11-29 19:10:21 +000012The experimental :program:`llvm-cov` tool reads in description file generated
13by compiler and coverage data file generated by instrumented program. This
14program assumes that the description and data file uses same format as gcov
15files.
Daniel Dunbar3b709d52012-05-08 16:50:35 +000016
17OPTIONS
18-------
19
Dmitri Gribenko90d0e7e2012-11-29 19:10:21 +000020.. option:: -gcno=filename
Daniel Dunbar3b709d52012-05-08 16:50:35 +000021
Dmitri Gribenko90d0e7e2012-11-29 19:10:21 +000022 This option selects input description file generated by compiler while
23 instrumenting program.
Daniel Dunbar3b709d52012-05-08 16:50:35 +000024
Dmitri Gribenko90d0e7e2012-11-29 19:10:21 +000025.. option:: -gcda=filename
Daniel Dunbar3b709d52012-05-08 16:50:35 +000026
27 This option selects coverage data file generated by instrumented compiler.
28
Dmitri Gribenko90d0e7e2012-11-29 19:10:21 +000029.. option:: -dump
Daniel Dunbar3b709d52012-05-08 16:50:35 +000030
Dmitri Gribenko90d0e7e2012-11-29 19:10:21 +000031 This options enables output dump that is suitable for a developer to help
32 debug :program:`llvm-cov` itself.
Daniel Dunbar3b709d52012-05-08 16:50:35 +000033
34EXIT STATUS
35-----------
36
Dmitri Gribenko90d0e7e2012-11-29 19:10:21 +000037:program:`llvm-cov` returns 1 if it cannot read input files. Otherwise, it
38exits with zero.
Daniel Dunbar3b709d52012-05-08 16:50:35 +000039