summaryrefslogtreecommitdiff
path: root/docs/logilab-pytest.1
diff options
context:
space:
mode:
Diffstat (limited to 'docs/logilab-pytest.1')
-rw-r--r--docs/logilab-pytest.154
1 files changed, 54 insertions, 0 deletions
diff --git a/docs/logilab-pytest.1 b/docs/logilab-pytest.1
new file mode 100644
index 0000000..51aec2e
--- /dev/null
+++ b/docs/logilab-pytest.1
@@ -0,0 +1,54 @@
+.TH logilab-pytest "1" "January 2008" logilab-pytest
+.SH NAME
+.B logilab-pytest
+\- run python unit tests
+
+.SH SYNOPSIS
+usage: logilab-pytest [OPTIONS] [testfile [testpattern]]
+.PP
+examples:
+.PP
+logilab-pytest path/to/mytests.py
+logilab-pytest path/to/mytests.py TheseTests
+logilab-pytest path/to/mytests.py TheseTests.test_thisone
+.PP
+logilab-pytest one (will run both test_thisone and test_thatone)
+logilab-pytest path/to/mytests.py \fB\-s\fR not (will skip test_notthisone)
+.PP
+logilab-pytest \fB\-\-coverage\fR test_foo.py
+.IP
+(only if logilab.devtools is available)
+.SS "options:"
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+show this help message and exit
+.TP
+\fB\-t\fR TESTDIR
+directory where the tests will be found
+.TP
+\fB\-d\fR
+enable design\-by\-contract
+.TP
+\fB\-v\fR, \fB\-\-verbose\fR
+Verbose output
+.TP
+\fB\-i\fR, \fB\-\-pdb\fR
+Enable test failure inspection (conflicts with
+\fB\-\-coverage\fR)
+.TP
+\fB\-x\fR, \fB\-\-exitfirst\fR
+Exit on first failure (only make sense when logilab-pytest run
+one test file)
+.TP
+\fB\-s\fR SKIPPED, \fB\-\-skip\fR=\fISKIPPED\fR
+test names matching this name will be skipped to skip
+several patterns, use commas
+.TP
+\fB\-q\fR, \fB\-\-quiet\fR
+Minimal output
+.TP
+\fB\-P\fR PROFILE, \fB\-\-profile\fR=\fIPROFILE\fR
+Profile execution and store data in the given file
+.TP
+\fB\-\-coverage\fR
+run tests with pycoverage (conflicts with \fB\-\-pdb\fR)