1
<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
3
<!-- Process this file with docbook-to-man to generate an nroff manual
4
page: `docbook-to-man manpage.sgml > manpage.1'. You may view
5
the manual page with: `docbook-to-man manpage.sgml | nroff -man |
6
less'. A typical entry in a Makefile or Makefile.am is:
8
manpage.1: manpage.sgml
12
The docbook-to-man binary is found in the docbook-to-man package.
13
Please remember that if you create the nroff version in one of the
14
debian/rules file targets (such as build), you will need to include
15
docbook-to-man in your Build-Depends control field.
19
<!-- Fill in your name for FIRSTNAME and SURNAME. -->
20
<!ENTITY dhfirstname "<firstname>Miguel</firstname>">
21
<!ENTITY dhsurname "<surname>Landaeta</surname>">
22
<!-- Please adjust the date whenever revising the manpage. -->
23
<!ENTITY dhdate "<date>January 19, 2010</date>">
24
<!-- SECTION should be 1-8, maybe w/ subsection other parameters are
25
allowed: see man(7), man(1). -->
26
<!ENTITY dhsection "<manvolnum>1</manvolnum>">
27
<!ENTITY dhemail "<email>miguel@miguel.cc</email>">
28
<!ENTITY dhusername "Miguel Landaeta">
29
<!ENTITY dhucpackage "<refentrytitle>COBERTURA-REPORT</refentrytitle>">
30
<!ENTITY dhpackage "cobertura-report">
32
<!ENTITY debian "<productname>Debian</productname>">
33
<!ENTITY gnu "<acronym>GNU</acronym>">
47
<holder>&dhusername;</holder>
57
<refname>&dhpackage;</refname>
59
<refpurpose>generate coverage reports</refpurpose>
63
<command>&dhpackage;</command>
65
<arg><option>--datafile file</option></arg>
66
<arg choice="req">--destination dir</arg>
67
<arg><option>--format html|xml</option></arg>
68
<arg><option>--encoding encoding</option></arg>
69
<arg choice="req">directory</arg>
70
<arg><option>--basedir dir</option></arg>
75
<title>DESCRIPTION</title>
77
<para><command>&dhpackage;</command> generates coverage reports from the
78
source code directories and calculates the cyclomatic code complexity
79
of each class. The HTML reports are also made of annotated versions
80
of each source file, showing which lines of code were excercised.
85
<title>OPTIONS</title>
89
<term><option>--datafile file</option>
92
<para>Specify the name of the file containing metadata about your
93
classes. Default value: "./cobertura.ser".</para>
97
<term><option>--basedir dir</option>
100
<para>Specify a directory containing source code. All files listed
101
after this are assumed to be underneath this directory. This
102
should only be used if you want to include only a few specific
103
files underneath a source tree and exclude all other files.
108
<term><option>--destination dir</option>
112
Specify the output directory for the report.</para>
116
<term><option>--format xml|html</option>
120
The type of report you want to generate. Default value: html.
125
<term><option>--encoding encoding</option>
128
<para>Specify the encoding used to read the source. See javadocs for
129
java.nio.charset.Charset for more details.</para>
135
<title>SEE ALSO</title>
137
<para>junit(1), cobertura-instrument(1), cobertura-check(1),
138
cobertura-merge(1).</para>
142
<title>AUTHOR</title>
144
<para>This manual page was written by &dhusername; <&dhemail;>
145
for the &debian; system (but may be used by others). Permission is
146
granted to copy, distribute and/or modify this document under
147
the terms of the terms of &gnu; General Public License, Version 2
148
or any later version published by the Free Software Foundation.
150
<para>On Debian systems, the complete text of the GNU General Public
151
License can be found in /usr/share/common-licenses/GPL.
157
<!-- Keep this comment at the end of the file
162
sgml-minimize-attributes:nil
163
sgml-always-quote-attributes:t
166
sgml-parent-document:nil
167
sgml-default-dtd-file:nil
168
sgml-exposed-tags:nil
169
sgml-local-catalogs:nil
170
sgml-local-ecat-files:nil
added
removed
debian/cobertura-report.sgml
