[llvm-commits] [llvm] r145319 - in /llvm/trunk/docs/CommandGuide: index.html llvm-cov.pod

[Devang Patel]

Author: dpatel
Date: Mon Nov 28 17:39:25 2011
New Revision: 145319

URL: http://llvm.org/viewvc/llvm-project?rev=145319&view=rev
Log:
Add documentation for llvm-cov.

Added:
    llvm/trunk/docs/CommandGuide/llvm-cov.pod
Modified:
    llvm/trunk/docs/CommandGuide/index.html

Modified: llvm/trunk/docs/CommandGuide/index.html
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CommandGuide/index.html?rev=145319&r1=145318&r2=145319&view=diff
==============================================================================
--- llvm/trunk/docs/CommandGuide/index.html (original)
+++ llvm/trunk/docs/CommandGuide/index.html Mon Nov 28 17:39:25 2011
@@ -72,6 +72,9 @@
 <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>

Added: llvm/trunk/docs/CommandGuide/llvm-cov.pod
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CommandGuide/llvm-cov.pod?rev=145319&view=auto
==============================================================================
--- llvm/trunk/docs/CommandGuide/llvm-cov.pod (added)
+++ llvm/trunk/docs/CommandGuide/llvm-cov.pod Mon Nov 28 17:39:25 2011
@@ -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