← Back to branch summary

~ubuntu-branches/ubuntu/precise/cobertura/precise

« back to all changes in this revision

Viewing changes to debian/cobertura-check.sgml

  • Committer: Bazaar Package Importer
  • Author(s): Miguel Landaeta
  • Date: 2010-05-11 19:21:46 UTC
  • mfrom: (0.1.4 sid) (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20100511192146-j742v5jsl89ztndu
Tags: 1.9.4.1+dfsg-2
http://bugs.debian.org/580842
* Now Build-Depends on libservlet2.5-java and add a missing Depends
  on the same package. (Closes: #580842). 
* Simplify list of JRE dependences for cobertura and drop JRE dependences for
  libcobertura-java as Java libraries are no longer required to depend on a
  JVM.

Show diffs side-by-side

added added

removed removed

Lines of Context:
debian/cobertura-check.sgml
 
1
<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
 
2
 
 
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:
 
7
 
 
8
manpage.1: manpage.sgml
 
9
        docbook-to-man $< > $@
 
10
 
 
11
    
 
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.
 
16
 
 
17
  -->
 
18
 
 
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-CHECK</refentrytitle>">
 
30
  <!ENTITY dhpackage   "cobertura-check">
 
31
 
 
32
  <!ENTITY debian      "<productname>Debian</productname>">
 
33
  <!ENTITY gnu         "<acronym>GNU</acronym>">
 
34
]>
 
35
 
 
36
<refentry>
 
37
  <refentryinfo>
 
38
    <address>
 
39
      &dhemail;
 
40
    </address>
 
41
    <author>
 
42
      &dhfirstname;
 
43
      &dhsurname;
 
44
    </author>
 
45
    <copyright>
 
46
      <year>2010</year>
 
47
      <holder>&dhusername;</holder>
 
48
    </copyright>
 
49
    &dhdate;
 
50
  </refentryinfo>
 
51
  <refmeta>
 
52
    &dhucpackage;
 
53
 
 
54
    &dhsection;
 
55
  </refmeta>
 
56
  <refnamediv>
 
57
    <refname>&dhpackage;</refname>
 
58
 
 
59
    <refpurpose>show which classes do not have adequate test coverage</refpurpose>
 
60
  </refnamediv>
 
61
  <refsynopsisdiv>
 
62
    <cmdsynopsis>
 
63
      <command>&dhpackage;</command>
 
64
 
 
65
      <arg><option>--branch 0..100</option></arg>
 
66
      <arg><option>--datafile file</option></arg>
 
67
      <arg><option>--line 0..100</option></arg>
 
68
      <arg><option>--regex regex:branchrate:linerate</option></arg>
 
69
      <arg><option>--packagebranch 0..100</option></arg>
 
70
      <arg><option>--packageline 0..100</option></arg>
 
71
      <arg><option>--totalbranch 0..100</option></arg>
 
72
      <arg><option>--totalline 0..100</option></arg>
 
73
 
 
74
    </cmdsynopsis>
 
75
  </refsynopsisdiv>
 
76
  <refsect1>
 
77
    <title>DESCRIPTION</title>
 
78
 
 
79
    <para><command>&dhpackage;</command> can be run after your JUnit tests
 
80
      to show which classes do not have adequate test coverage.
 
81
    </para>
 
82
 
 
83
  </refsect1>
 
84
  <refsect1>
 
85
    <title>OPTIONS</title>
 
86
 
 
87
    <para>If no parameters are specified then all values will be set to
 
88
     50%.</para>
 
89
 
 
90
    <variablelist>
 
91
      <varlistentry>
 
92
        <term><option>--branch 0..100</option>
 
93
        </term>
 
94
        <listitem>
 
95
          <para>Specify the minimum acceptable branch coverage rate needed
 
96
            by each class. This should be an integer value between 0 and
 
97
            100. Default value is 0.</para>
 
98
        </listitem>
 
99
      </varlistentry>
 
100
      <varlistentry>
 
101
        <term><option>--datafile file</option>
 
102
        </term>
 
103
        <listitem>
 
104
          <para>Specify the name of the file containing metadata about
 
105
            your classes. Default value: "./cobertura.ser".</para>
 
106
        </listitem>
 
107
      </varlistentry>
 
108
      <varlistentry>
 
109
        <term><option>--line 0..100</option>
 
110
        </term>
 
111
        <listitem>
 
112
          <para>Specify the minimum acceptable line coverage rate needed
 
113
            by each class. This should be an integer value between 0 and
 
114
            100. Default value is 0.</para>
 
115
        </listitem>
 
116
      </varlistentry>
 
117
      <varlistentry>
 
118
        <term><option>--regex regex:branchrate:linerate</option>
 
119
        </term>
 
120
        <listitem>
 
121
          <para>For finer grained control, you can optionally specify
 
122
            minimum branch and line coverage rates for individual classes
 
123
            using any number of regular expressions.</para>
 
124
        </listitem>
 
125
      </varlistentry>
 
126
      <varlistentry>
 
127
        <term><option>--packagebranch 0..100</option>
 
128
        </term>
 
129
        <listitem>
 
130
          <para>Specify the minimum acceptable average branch coverage
 
131
            rate needed by each package. This should be an integer value
 
132
            between 0 and 100. Default value is 0.</para>
 
133
        </listitem>
 
134
      </varlistentry>
 
135
      <varlistentry>
 
136
        <term><option>--packageline 0..100</option>
 
137
        </term>
 
138
        <listitem>
 
139
          <para>Specify the minimum acceptable average line coverage
 
140
            rate needed by each package. This should be an integer value
 
141
            between 0 and 100. Default value is 0.</para>
 
142
        </listitem>
 
143
      </varlistentry>
 
144
      <varlistentry>
 
145
        <term><option>--totalbranch 0..100</option>
 
146
        </term>
 
147
        <listitem>
 
148
          <para>Specify the minimum acceptable average branch coverage
 
149
            rate needed by the project as a whole. This should be an
 
150
            integer value between 0 and 100. Default value is 0.</para>
 
151
        </listitem>
 
152
      </varlistentry>
 
153
      <varlistentry>
 
154
        <term><option>--totalline 0..100</option>
 
155
        </term>
 
156
        <listitem>
 
157
          <para>Specify the minimum acceptable average line coverage
 
158
            rate needed by the project as a whole. This should be an
 
159
            integer value between 0 and 100. Default value is 0.</para>
 
160
        </listitem>
 
161
      </varlistentry>
 
162
    </variablelist>
 
163
  </refsect1>
 
164
  <refsect1>
 
165
    <title>SEE ALSO</title>
 
166
 
 
167
    <para>junit(1), cobertura-instrument(1), cobertura-report(1),
 
168
      cobertura-merge(1).</para>
 
169
 
 
170
  </refsect1>
 
171
  <refsect1>
 
172
    <title>AUTHOR</title>
 
173
 
 
174
    <para>This manual page was written by &dhusername; &lt;&dhemail;&gt;
 
175
      for the &debian; system (but may be used by others).  Permission is
 
176
      granted to copy, distribute and/or modify this document under
 
177
      the terms of the terms of &gnu; General Public License, Version 2 
 
178
      or any later version published by the Free Software Foundation.
 
179
    </para>
 
180
    <para>On Debian systems, the complete text of the GNU General Public
 
181
      License can be found in /usr/share/common-licenses/GPL.
 
182
    </para>
 
183
 
 
184
  </refsect1>
 
185
</refentry>
 
186
 
 
187
<!-- Keep this comment at the end of the file
 
188
Local variables:
 
189
mode: sgml
 
190
sgml-omittag:t
 
191
sgml-shorttag:t
 
192
sgml-minimize-attributes:nil
 
193
sgml-always-quote-attributes:t
 
194
sgml-indent-step:2
 
195
sgml-indent-data:t
 
196
sgml-parent-document:nil
 
197
sgml-default-dtd-file:nil
 
198
sgml-exposed-tags:nil
 
199
sgml-local-catalogs:nil
 
200
sgml-local-ecat-files:nil
 
201
End:
 
202
-->
 
203
 
 
204