[Python-modules-commits] [python-flake8] 01/04: Updated manpage for new release

Thu Aug 11 18:43:31 UTC 2016

This is an automated email from the git hooks/post-receive script.

onovy pushed a commit to branch master
in repository python-flake8.

commit 56486ab2e539483811b5697614a2304817a24ad3
Author: Ondřej Nový <onovy at debian.org>
Date:   Thu Aug 11 20:25:37 2016 +0200

    Updated manpage for new release
---
 debian/changelog |   1 +
 debian/flake8.1  | 146 +++++++++++++++++++++++++++++++++++--------------------
 2 files changed, 94 insertions(+), 53 deletions(-)

diff --git a/debian/changelog b/debian/changelog
index 53a6431..d75a350 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -13,6 +13,7 @@ python-flake8 (3.0.4+dfsg1-1) UNRELEASED; urgency=medium
   * d/rules: Cleanup and use pybuild
   * Removed prebuilded docs from orig tarball
   * d/copyright: Fixed for new upstream release
+  * Updated manpage for new release
 
  -- Barry Warsaw <barry at debian.org>  Mon, 20 Jun 2016 12:27:19 -0400
 
diff --git a/debian/flake8.1 b/debian/flake8.1
index f08fbeb..b6dd86d 100644
--- a/debian/flake8.1
+++ b/debian/flake8.1
@@ -1,6 +1,6 @@
-.TH FLAKE8 "1" "November 2013" "flake8 2.0 (pep8: 1.4.6, mccabe: 0.2, pyflakes: 0.7.3)" "User Commands"
+.TH FLAKE8 "1" "August 2016"
 .SH NAME
-flake8 \- code checker using pep8 and pyflakes
+flake8 \- code checker using pycodestyle and pyflakes
 .SH SYNOPSIS
 .B flake8
 [\fIoptions\fR] \fIinput \fR...
@@ -13,81 +13,121 @@ show program's version number and exit
 show this help message and exit
 .TP
 \fB\-v\fR, \fB\-\-verbose\fR
-print status messages, or debug with \fB\-vv\fR
+print more information about what is happening in
+flake8. This option is repeatable and will increase
+verbosity each time it is repeated.
 .TP
 \fB\-q\fR, \fB\-\-quiet\fR
-report only file names, or nothing with \fB\-qq\fR
+report only file names, or nothing. This option is
+repeatable.
 .TP
-\fB\-\-first\fR
-show first occurrence of each error
+\fB\-\-count\fR
+print total number of errors and warnings to standard
+error and set the exit code to 1 if total is not
+empty.
 .TP
-\fB\-\-exclude\fR=\fIpatterns\fR
-exclude files or directories which match these comma
-separated patterns (default:
-\&.svn,CVS,.bzr,.hg,.git,__pycache__)
+\fB\-\-diff\fR
+report changes only within line number ranges in the
+unified diff provided on standard in by the user.
 .TP
-\fB\-\-filename\fR=\fIpatterns\fR
-when parsing directories, only check filenames
-matching these comma separated patterns (default:
-*.py)
+\fB\-\-exclude\fR=\fI\,patterns\/\fR
+comma\-separated list of files or directories to
+exclude. (Default:
+\&.svn,CVS,.bzr,.hg,.git,__pycache__,.tox,.eggs,*.egg)
 .TP
-\fB\-\-select\fR=\fIerrors\fR
-select errors and warnings (e.g. E,W6)
+\fB\-\-filename\fR=\fI\,patterns\/\fR
+only check for filenames matching the patterns in this
+comma\-separated list. (Default: *.py)
 .TP
-\fB\-\-ignore\fR=\fIerrors\fR
-skip errors and warnings (e.g. E4,W)
+\fB\-\-stdin\-display\-name\fR=\fI\,STDIN_DISPLAY_NAME\/\fR
+the name used when reporting errors from code passed
+via stdin. This is useful for editors piping the file
+contents to flake8. (Default: stdin)
 .TP
-\fB\-\-show\-source\fR
-show source code for each error
+\fB\-\-format\fR=\fI\,format\/\fR
+format errors according to the chosen formatter.
 .TP
-\fB\-\-show\-pep8\fR
-show text of PEP 8 for each error (implies \fB\-\-first\fR)
+\fB\-\-hang\-closing\fR
+hang closing bracket instead of matching indentation
+of opening bracket's line.
 .TP
-\fB\-\-statistics\fR
-count errors and warnings
+\fB\-\-ignore\fR=\fI\,errors\/\fR
+comma\-separated list of errors and warnings to ignore
+(or skip). For example, \fB\-\-ignore\fR=E4,E51,W234.
+(Default: E121,E123,E126,E226,E24,E704,W503,W504)
 .TP
-\fB\-\-count\fR
-print total number of errors and warnings to standard
-error and set exit code to 1 if total is not null
+\fB\-\-max\-line\-length\fR=\fI\,n\/\fR
+maximum allowed line length for the entirety of this
+run. (Default: 79)
 .TP
-\fB\-\-max\-line\-length\fR=\fIn\fR
-set maximum allowed line length (default: 79)
+\fB\-\-select\fR=\fI\,errors\/\fR
+comma\-separated list of errors and warnings to enable.
+For example, \fB\-\-select\fR=E4,E51,W234. (Default: E,F,W,C90)
 .TP
-\fB\-\-hang\-closing\fR
-hang closing bracket instead of matching indentation
-of opening bracket's line
+\fB\-\-disable\-noqa\fR
+disable the effect of "# noqa". This will report
+errors on lines with "# noqa" at the end.
 .TP
-\fB\-\-format\fR=\fIformat\fR
-set the error format [default|pylint|<custom>]
+\fB\-\-show\-source\fR
+show the source generate each error or warning.
 .TP
-\fB\-\-diff\fR
-report only lines changed according to the unified
-diff received on STDIN
+\fB\-\-statistics\fR
+count errors and warnings.
+.TP
+\fB\-\-enable\-extensions\fR=\fI\,ENABLE_EXTENSIONS\/\fR
+enable plugins and extensions that are otherwise
+disabled by default
 .TP
 \fB\-\-exit\-zero\fR
-exit with code 0 even if there are errors
+exit with status code "0" even if there are errors.
+.TP
+\fB\-\-install\-hook\fR=\fI\,INSTALL_HOOK\/\fR
+install a hook that is run prior to a commit for the
+supported version control systema.
+.TP
+\fB\-j\fR \fIJOBS\fR, \fB\-\-jobs\fR=\fI\,JOBS\/\fR
+number of subprocesses to use to run checks in
+parallel. This is ignored on Windows. The default,
+"auto", will auto\-detect the number of processors
+available to use. (Default: auto)
+.TP
+\fB\-\-output\-file\fR=\fI\,OUTPUT_FILE\/\fR
+redirect report to a file.
+.TP
+\fB\-\-append\-config\fR=\fI\,APPEND_CONFIG\/\fR
+provide extra config files to parse in addition to the
+files found by Flake8 by default. These files are the
+last ones read and so they take the highest precedence
+when multiple files provide the same option.
+.TP
+\fB\-\-config\fR=\fI\,CONFIG\/\fR
+path to the config file that will be the authoritative
+config source. This will cause Flake8 to ignore all
+other configuration files.
 .TP
-\fB\-\-max\-complexity\fR=\fIMAX_COMPLEXITY\fR
+\fB\-\-isolated\fR
+ignore all found configuration files.
+.TP
+\fB\-\-benchmark\fR
+print benchmark information about this run of Flake8
+.TP
+\fB\-\-max\-complexity\fR=\fI\,MAX_COMPLEXITY\/\fR
 McCabe complexity threshold
 .TP
-\fB\-\-builtins\fR=\fIBUILTINS\fR
+\fB\-\-builtins\fR=\fI\,BUILTINS\/\fR
 define more built\-ins, comma separated
 .TP
-\fB\-\-install\-hook\fR
-Install the appropriate hook for this repository.
-.IP
-Testing Options:
+\fB\-\-doctests\fR
+check syntax of the doctests
 .TP
-\fB\-\-benchmark\fR
-measure processing speed
-.IP
-Configuration:
-.IP
+\fB\-\-include\-in\-doctest\fR=\fI\,INCLUDE_IN_DOCTEST\/\fR
+run doctests only on these files
+.TP
+\fB\-\-exclude\-from\-doctest\fR=\fI\,EXCLUDE_FROM_DOCTEST\/\fR
+skip these files when running doctests
+.PP
+.SH "CONFIGURATION"
 The project options are read from the [flake8] section of the tox.ini
 file or the setup.cfg file located in any parent folder of the path(s)
 being processed.  Allowed options are: exclude, filename, select,
 ignore, max\-line\-length, hang\-closing, count, format, quiet, showpep8, show\-source, statistics, verbose, max\-complexity, builtins.
-.TP
-\fB\-\-config\fR=\fIpath\fR
-user config file location (default:
-~/.config/flake8)

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/python-modules/packages/python-flake8.git

