Add documentation for llvm-cov.
authorDevang Patel <dpatel@apple.com>
Mon, 28 Nov 2011 23:39:25 +0000 (23:39 +0000)
committerDevang Patel <dpatel@apple.com>
Mon, 28 Nov 2011 23:39:25 +0000 (23:39 +0000)
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@145319 91177308-0d34-0410-b5e6-96231b3b80d8

docs/CommandGuide/index.html
docs/CommandGuide/llvm-cov.pod [new file with mode: 0644]

index 166cca1bade450ec61486276b4ad313a69fca81b..145569c96c6d5b294c213621093966e07abe948e 100644 (file)
@@ -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 (file)
index 0000000..e8ff683
--- /dev/null
@@ -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