From 5e19c1f945577b591ff218da738de3873b77f972 Mon Sep 17 00:00:00 2001 From: Devang Patel Date: Mon, 28 Nov 2011 23:39:25 +0000 Subject: [PATCH] Add documentation for llvm-cov. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@145319 91177308-0d34-0410-b5e6-96231b3b80d8 --- docs/CommandGuide/index.html | 3 +++ docs/CommandGuide/llvm-cov.pod | 45 ++++++++++++++++++++++++++++++++++ 2 files changed, 48 insertions(+) create mode 100644 docs/CommandGuide/llvm-cov.pod diff --git a/docs/CommandGuide/index.html b/docs/CommandGuide/index.html index 166cca1bade..145569c96c6 100644 --- a/docs/CommandGuide/index.html +++ b/docs/CommandGuide/index.html @@ -72,6 +72,9 @@ options) arguments to the tool you are interested in.

  • llvm-diff - structurally compare two modules
  • +
  • llvm-cov - + emit coverage information
  • + diff --git a/docs/CommandGuide/llvm-cov.pod b/docs/CommandGuide/llvm-cov.pod new file mode 100644 index 00000000000..e8ff6831175 --- /dev/null +++ b/docs/CommandGuide/llvm-cov.pod @@ -0,0 +1,45 @@ +=pod + +=head1 NAME + +llvm-cov - emit coverage information + +=head1 SYNOPSIS + +B [-gcno=filename] [-gcda=filename] [dump] + +=head1 DESCRIPTION + +The experimental B 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 itself. + +=back + +=head1 EXIT STATUS + +B returns 1 if it cannot read input files. Otherwise, it exits with zero. + +=head1 AUTHOR + +B is maintained by the LLVM Team (L). + +=cut