Mercurial Mercurial > upstream > oracle > userland-gate / annotate
summary | shortlog | changelog | graph | tags | bookmarks | branches | files | changeset | file | latest | revisions | annotate | diff | comparison | raw | help
Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
components/python/pep8/files/pep8.1
author Rich Burridge <rich.burridge@oracle.com>
Tue, 23 Apr 2013 06:59:16 -0700
branchs11-update
changeset 2582 bb7506e1881b
permissions -rw-r--r--
PSARC 2012/301 pep8 version 1.3.3 - Python Style Guide Checker 16425619 Request to update pep8 to the latest version in s12 16425549 pep8 needs a man page.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2582
bb7506e1881b PSARC 2012/301 pep8 version 1.3.3 - Python Style Guide Checker
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset 
     1
 
.\" This manual page is derived from documentation obtained from
bb7506e1881b PSARC 2012/301 pep8 version 1.3.3 - Python Style Guide Checker
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset 
     2
 
.\" http://manpages.ubuntu.com/manpages/precise/en/man1/pep8.1.html
bb7506e1881b PSARC 2012/301 pep8 version 1.3.3 - Python Style Guide Checker
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset 
     3
 
.TH PEP8 "1" "March 2013" "pep8 XXX" "User Commands"
bb7506e1881b PSARC 2012/301 pep8 version 1.3.3 - Python Style Guide Checker
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset 
     4
 
.SH NAME
bb7506e1881b PSARC 2012/301 pep8 version 1.3.3 - Python Style Guide Checker
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset 
     5
 
pep8 \- A tool to check your Python code against some of the style conventions in PEP 8.
bb7506e1881b PSARC 2012/301 pep8 version 1.3.3 - Python Style Guide Checker
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset 
     6
 
.SH SYNOPSIS
bb7506e1881b PSARC 2012/301 pep8 version 1.3.3 - Python Style Guide Checker
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset 
     7
 
.B pep8
bb7506e1881b PSARC 2012/301 pep8 version 1.3.3 - Python Style Guide Checker
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset 
     8
 
[\fIoptions\fR] \fIinput \fR...
bb7506e1881b PSARC 2012/301 pep8 version 1.3.3 - Python Style Guide Checker
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset 
     9
 
.SH OPTIONS
bb7506e1881b PSARC 2012/301 pep8 version 1.3.3 - Python Style Guide Checker
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset 
    10
 
.TP
bb7506e1881b PSARC 2012/301 pep8 version 1.3.3 - Python Style Guide Checker
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset 
    11
 
\fB\-h\fR, \fB\-\-help\fR
bb7506e1881b PSARC 2012/301 pep8 version 1.3.3 - Python Style Guide Checker
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset 
    12
 
show this help message and exit
bb7506e1881b PSARC 2012/301 pep8 version 1.3.3 - Python Style Guide Checker
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset 
    13
 
.TP
bb7506e1881b PSARC 2012/301 pep8 version 1.3.3 - Python Style Guide Checker
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset 
    14
 
\fB\-v\fR, \fB\-\-verbose\fR
bb7506e1881b PSARC 2012/301 pep8 version 1.3.3 - Python Style Guide Checker
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset 
    15
 
print status messages, or debug with \fB\-vv\fR
bb7506e1881b PSARC 2012/301 pep8 version 1.3.3 - Python Style Guide Checker
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset 
    16
 
.TP
bb7506e1881b PSARC 2012/301 pep8 version 1.3.3 - Python Style Guide Checker
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset 
    17
 
\fB\-q\fR, \fB\-\-quiet\fR
bb7506e1881b PSARC 2012/301 pep8 version 1.3.3 - Python Style Guide Checker
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset 
    18
 
report only file names, or nothing with \fB\-qq\fR
bb7506e1881b PSARC 2012/301 pep8 version 1.3.3 - Python Style Guide Checker
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset 
    19
 
.TP
bb7506e1881b PSARC 2012/301 pep8 version 1.3.3 - Python Style Guide Checker
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset 
    20
 
\fB\-\-exclude\fR=\fIpatterns\fR
bb7506e1881b PSARC 2012/301 pep8 version 1.3.3 - Python Style Guide Checker
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset 
    21
 
skip matches (default .svn,CVS,*.pyc,*.pyo)
bb7506e1881b PSARC 2012/301 pep8 version 1.3.3 - Python Style Guide Checker
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset 
    22
 
.TP
bb7506e1881b PSARC 2012/301 pep8 version 1.3.3 - Python Style Guide Checker
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset 
    23
 
\fB\-\-filename\fR=\fIpatterns\fR
bb7506e1881b PSARC 2012/301 pep8 version 1.3.3 - Python Style Guide Checker
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset 
    24
 
only check matching files (e.g. *.py)
bb7506e1881b PSARC 2012/301 pep8 version 1.3.3 - Python Style Guide Checker
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset 
    25
 
.TP
bb7506e1881b PSARC 2012/301 pep8 version 1.3.3 - Python Style Guide Checker
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset 
    26
 
\fB\-\-ignore\fR=\fIerrors\fR
bb7506e1881b PSARC 2012/301 pep8 version 1.3.3 - Python Style Guide Checker
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset 
    27
 
skip errors and warnings (e.g. E4,W)
bb7506e1881b PSARC 2012/301 pep8 version 1.3.3 - Python Style Guide Checker
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset 
    28
 
.TP
bb7506e1881b PSARC 2012/301 pep8 version 1.3.3 - Python Style Guide Checker
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset 
    29
 
\fB\-\-repeat\fR
bb7506e1881b PSARC 2012/301 pep8 version 1.3.3 - Python Style Guide Checker
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset 
    30
 
show all occurrences of the same error
bb7506e1881b PSARC 2012/301 pep8 version 1.3.3 - Python Style Guide Checker
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset 
    31
 
.TP
bb7506e1881b PSARC 2012/301 pep8 version 1.3.3 - Python Style Guide Checker
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset 
    32
 
\fB\-\-show\-source\fR
bb7506e1881b PSARC 2012/301 pep8 version 1.3.3 - Python Style Guide Checker
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset 
    33
 
show source code for each error
bb7506e1881b PSARC 2012/301 pep8 version 1.3.3 - Python Style Guide Checker
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset 
    34
 
.TP
bb7506e1881b PSARC 2012/301 pep8 version 1.3.3 - Python Style Guide Checker
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset 
    35
 
\fB\-\-show\-pep8\fR
bb7506e1881b PSARC 2012/301 pep8 version 1.3.3 - Python Style Guide Checker
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset 
    36
 
show text of PEP 8 for each error
bb7506e1881b PSARC 2012/301 pep8 version 1.3.3 - Python Style Guide Checker
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset 
    37
 
.TP
bb7506e1881b PSARC 2012/301 pep8 version 1.3.3 - Python Style Guide Checker
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset 
    38
 
\fB\-\-statistics\fR
bb7506e1881b PSARC 2012/301 pep8 version 1.3.3 - Python Style Guide Checker
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset 
    39
 
count errors and warnings
bb7506e1881b PSARC 2012/301 pep8 version 1.3.3 - Python Style Guide Checker
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset 
    40
 
.TP
bb7506e1881b PSARC 2012/301 pep8 version 1.3.3 - Python Style Guide Checker
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset 
    41
 
\fB\-\-benchmark\fR
bb7506e1881b PSARC 2012/301 pep8 version 1.3.3 - Python Style Guide Checker
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset 
    42
 
measure processing speed
bb7506e1881b PSARC 2012/301 pep8 version 1.3.3 - Python Style Guide Checker
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset 
    43
 
.TP
bb7506e1881b PSARC 2012/301 pep8 version 1.3.3 - Python Style Guide Checker
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset 
    44
 
\fB\-\-testsuite\fR=\fIdir\fR
bb7506e1881b PSARC 2012/301 pep8 version 1.3.3 - Python Style Guide Checker
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset 
    45
 
run regression tests from dir
bb7506e1881b PSARC 2012/301 pep8 version 1.3.3 - Python Style Guide Checker
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset 
    46
 
.TP
bb7506e1881b PSARC 2012/301 pep8 version 1.3.3 - Python Style Guide Checker
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset 
    47
 
\fB\-\-doctest\fR
bb7506e1881b PSARC 2012/301 pep8 version 1.3.3 - Python Style Guide Checker
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset 
    48
 
run doctest on myself
bb7506e1881b PSARC 2012/301 pep8 version 1.3.3 - Python Style Guide Checker
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset 
    49
 
.SH AUTHOR
bb7506e1881b PSARC 2012/301 pep8 version 1.3.3 - Python Style Guide Checker
Rich Burridge <rich.burridge@oracle.com>
parents:
diff changeset 
    50
 
This manual page was written by David Watson <[email protected]>.
upstream/oracle/userland-gate