summaryrefslogtreecommitdiff
path: root/docs/CommandGuide
diff options
context:
space:
mode:
authorDevang Patel <dpatel@apple.com>2011-11-28 23:39:25 +0000
committerDevang Patel <dpatel@apple.com>2011-11-28 23:39:25 +0000
commit5e19c1f945577b591ff218da738de3873b77f972 (patch)
treeb99e134e44c3649c4f433a88a677720dd99bbc30 /docs/CommandGuide
parent958da85b937a26f47eb2412e6e05656b93c07066 (diff)
downloadllvm-5e19c1f945577b591ff218da738de3873b77f972.tar.gz
llvm-5e19c1f945577b591ff218da738de3873b77f972.tar.bz2
llvm-5e19c1f945577b591ff218da738de3873b77f972.tar.xz
Add documentation for llvm-cov.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@145319 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'docs/CommandGuide')
-rw-r--r--docs/CommandGuide/index.html3
-rw-r--r--docs/CommandGuide/llvm-cov.pod45
2 files changed, 48 insertions, 0 deletions
diff --git a/docs/CommandGuide/index.html b/docs/CommandGuide/index.html
index 166cca1bad..145569c96c 100644
--- a/docs/CommandGuide/index.html
+++ b/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/docs/CommandGuide/llvm-cov.pod b/docs/CommandGuide/llvm-cov.pod
new file mode 100644
index 0000000000..e8ff683117
--- /dev/null
+++ b/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