← Back to branch summary

~ubuntu-branches/ubuntu/maverick/python-coverage/maverick

« back to all changes in this revision

Viewing changes to debian/python-coverage.1

  • Committer: Bazaar Package Importer
  • Author(s): Ben Finney, Ben Finney
  • Date: 2008-06-30 23:44:57 UTC
  • Revision ID: james.westby@ubuntu.com-20080630234457-mcxukedgt30t85mi
Tags: 2.80-1
[ Ben Finney ]
* New upstream release.
* debian/control
  + Added Ben Finney to Uploaders.
  + Set Standards-Version to 3.8.0 (no changes required).
  + Add Build-Depends-Indep: python-setuptools, as now used by upstream
    packaging.
  + Upgrade Build-Depends-Indep: python-central to version that doesn't
    require 'debian/pycompat'.
* debian/pycompat
  + Remove obsolete file.
* debian/watch
  + Added, pointing to upstream author's site.
* debian/rules
  + Upstream packaging installs program to '/usr/bin/coverage', move to
    '/usr/bin/python-coverage' to conform with existing versions.

Show diffs side-by-side

added added

removed removed

Lines of Context:
debian/python-coverage.1
 
1
.\" Copyright 2001 Gareth Rees.  All rights reserved.
 
2
.\" Copyright 2004-2006 Ned Batchelder.  All rights reserved.
 
3
.\" Copyright 2007 Lars Wirzenius.
 
4
.\"
 
5
.\" Redistribution and use in source and binary forms, with or without
 
6
.\" modification, are permitted provided that the following conditions are
 
7
.\" met:
 
8
.\"
 
9
.\" 1. Redistributions of source code must retain the above copyright
 
10
.\"    notice, this list of conditions and the following disclaimer.
 
11
.\"
 
12
.\" 2. Redistributions in binary form must reproduce the above copyright
 
13
.\"    notice, this list of conditions and the following disclaimer in the
 
14
.\"    documentation and/or other materials provided with the
 
15
.\"    distribution.
 
16
.\"
 
17
.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 
18
.\" "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 
19
.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 
20
.\" A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 
21
.\" HOLDERS AND CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 
22
.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 
23
.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
 
24
.\" OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 
25
.\" ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
 
26
.\" TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
 
27
.\" USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
 
28
.\" DAMAGE.
 
29
.\"
 
30
.TH PYTHON\-COVERAGE 1
 
31
.SH NAME
 
32
python\-coverage \- measure code coverage of Python program execution
 
33
.SH SYNOPSIS
 
34
.BI "python\-coverage \-x " module.py
 
35
.IR "" [ ARG ...]
 
36
.br
 
37
.BI "python\-coverage \-e"
 
38
.br
 
39
.BI "python\-coverage \-r"
 
40
.IR "" [ \-m ]
 
41
.br
 
42
.BI "python\-coverage \-a "
 
43
.IR "" [ file ...]
 
44
.SH DESCRIPTION
 
45
.B python\\-coverage
 
46
executes a Python program and measures which of its statements are
 
47
executed and which are not.
 
48
It stores the information in the file 
 
49
.B .coverage
 
50
in the current working directory.
 
51
.SH OPTIONS
 
52
.TP
 
53
.B -e
 
54
Erase the 
 
55
.B .coverage
 
56
file.
 
57
.TP
 
58
.B -x
 
59
Execute a Python module, giving it the remaining command line arguments.
 
60
.TP
 
61
.B -r
 
62
Produce a coverage report.
 
63
.TP
 
64
.B -m
 
65
With
 
66
.BR -r ,
 
67
show the line numbers that were missed by the execution.
 
68
.TP
 
69
.B -a
 
70
Annotate source files.
 
71
For each source file
 
72
.IR foo ,
 
73
produce
 
74
.IR foo,cover ,
 
75
with executed lines prefixed by ">" and non-executed by "!".
 
76
.TP
 
77
.B --help
 
78
Produce a help summary.
 
79
It might be more helpful than this manual page.
 
80
.SH AUTHOR
 
81
The
 
82
.B python-coverage
 
83
command is a one-line Python script which calls the 
 
84
.B coverage.py
 
85
Python module to do all the work.
 
86
The module was riginally developed by Gareth Rees, 
 
87
and is now developed by Ned Batchelder.
 
88
The module's home page is
 
89
.br
 
90
.IR http://www.nedbatchelder.com/code/modules/coverage.html .
 
91
.PP
 
92
This manual page was cobbled together by Lars Wirzenius for Debian,
 
93
by copy-pasting from the help texts from the module.