diff options
author | Devang Patel <dpatel@apple.com> | 2011-11-28 23:39:25 +0000 |
---|---|---|
committer | Devang Patel <dpatel@apple.com> | 2011-11-28 23:39:25 +0000 |
commit | 8e5bfd8349aedd930ae5a0c36832b57519fe3fce (patch) | |
tree | d3c4684ec8920d0e43d7a7776eda28f2dbcb31b6 | |
parent | 30168fbde58fb74da4d0858db2e4e784e1415056 (diff) | |
download | bcm5719-llvm-8e5bfd8349aedd930ae5a0c36832b57519fe3fce.tar.gz bcm5719-llvm-8e5bfd8349aedd930ae5a0c36832b57519fe3fce.zip |
Add documentation for llvm-cov.
llvm-svn: 145319
-rw-r--r-- | llvm/docs/CommandGuide/index.html | 3 | ||||
-rw-r--r-- | llvm/docs/CommandGuide/llvm-cov.pod | 45 |
2 files changed, 48 insertions, 0 deletions
diff --git a/llvm/docs/CommandGuide/index.html b/llvm/docs/CommandGuide/index.html index 166cca1bade..145569c96c6 100644 --- a/llvm/docs/CommandGuide/index.html +++ b/llvm/docs/CommandGuide/index.html @@ -72,6 +72,9 @@ options) arguments to the tool you are interested in.</p> <li><a href="/cmds/llvm-diff.html"><b>llvm-diff</b></a> - structurally compare two modules</li> +<li><a href="/cmds/llvm-cov.html"><b>llvm-cov</b></a> - + emit coverage information</li> + </ul> </div> diff --git a/llvm/docs/CommandGuide/llvm-cov.pod b/llvm/docs/CommandGuide/llvm-cov.pod new file mode 100644 index 00000000000..e8ff6831175 --- /dev/null +++ b/llvm/docs/CommandGuide/llvm-cov.pod @@ -0,0 +1,45 @@ +=pod + +=head1 NAME + +llvm-cov - emit coverage information + +=head1 SYNOPSIS + +B<llvm-cov> [-gcno=filename] [-gcda=filename] [dump] + +=head1 DESCRIPTION + +The experimental B<llvm-cov> tool reads in description file generated by compiler +and coverage data file generated by instrumented program. This program assumes +that the description and data file uses same format as gcov files. + +=head1 OPTIONS + +=over + +=item B<-gcno=filename] + +This option selects input description file generated by compiler while instrumenting +program. + +=item B<-gcda=filename] + +This option selects coverage data file generated by instrumented compiler. + +=item B<-dump> + +This options enables output dump that is suitable for a developer to help debug +B<llvm-cov> itself. + +=back + +=head1 EXIT STATUS + +B<llvm-cov> returns 1 if it cannot read input files. Otherwise, it exits with zero. + +=head1 AUTHOR + +B<llvm-cov> is maintained by the LLVM Team (L<http://llvm.org/>). + +=cut |