From 472e7c95895cb00c5de6dea8cd3a1a96dd30a7f8 Mon Sep 17 00:00:00 2001 From: Ian Cordasco Date: Tue, 14 Jun 2016 09:58:24 -0500 Subject: [PATCH] Add release notes portion of documentation --- docs/source/index.rst | 8 ++++++ docs/source/release-notes/0.6.0.rst | 4 +++ docs/source/release-notes/0.7.0.rst | 6 +++++ docs/source/release-notes/0.8.0.rst | 5 ++++ docs/source/release-notes/0.9.0.rst | 5 ++++ docs/source/release-notes/1.0.0.rst | 5 ++++ docs/source/release-notes/1.1.0.rst | 8 ++++++ docs/source/release-notes/1.2.0.rst | 6 +++++ docs/source/release-notes/1.3.0.rst | 4 +++ docs/source/release-notes/1.3.1.rst | 4 +++ docs/source/release-notes/1.4.0.rst | 5 ++++ docs/source/release-notes/1.5.0.rst | 9 +++++++ docs/source/release-notes/1.6.0.rst | 14 ++++++++++ docs/source/release-notes/1.6.1.rst | 7 +++++ docs/source/release-notes/1.6.2.rst | 4 +++ docs/source/release-notes/1.7.0.rst | 9 +++++++ docs/source/release-notes/2.0.0.rst | 13 ++++++++++ docs/source/release-notes/2.1.0.rst | 12 +++++++++ docs/source/release-notes/2.2.0.rst | 12 +++++++++ docs/source/release-notes/2.2.1.rst | 5 ++++ docs/source/release-notes/2.2.2.rst | 5 ++++ docs/source/release-notes/2.2.3.rst | 4 +++ docs/source/release-notes/2.2.4.rst | 20 +++++++++++++++ docs/source/release-notes/2.2.5.rst | 6 +++++ docs/source/release-notes/2.3.0.rst | 10 ++++++++ docs/source/release-notes/2.4.0.rst | 33 ++++++++++++++++++++++++ docs/source/release-notes/2.4.1.rst | 12 +++++++++ docs/source/release-notes/2.5.0.rst | 25 ++++++++++++++++++ docs/source/release-notes/2.5.1.rst | 13 ++++++++++ docs/source/release-notes/2.5.2.rst | 7 +++++ docs/source/release-notes/2.5.3.rst | 5 ++++ docs/source/release-notes/2.5.4.rst | 4 +++ docs/source/release-notes/2.5.5.rst | 7 +++++ docs/source/release-notes/index.rst | 40 +++++++++++++++++++++++++++++ 34 files changed, 336 insertions(+) create mode 100644 docs/source/release-notes/0.6.0.rst create mode 100644 docs/source/release-notes/0.7.0.rst create mode 100644 docs/source/release-notes/0.8.0.rst create mode 100644 docs/source/release-notes/0.9.0.rst create mode 100644 docs/source/release-notes/1.0.0.rst create mode 100644 docs/source/release-notes/1.1.0.rst create mode 100644 docs/source/release-notes/1.2.0.rst create mode 100644 docs/source/release-notes/1.3.0.rst create mode 100644 docs/source/release-notes/1.3.1.rst create mode 100644 docs/source/release-notes/1.4.0.rst create mode 100644 docs/source/release-notes/1.5.0.rst create mode 100644 docs/source/release-notes/1.6.0.rst create mode 100644 docs/source/release-notes/1.6.1.rst create mode 100644 docs/source/release-notes/1.6.2.rst create mode 100644 docs/source/release-notes/1.7.0.rst create mode 100644 docs/source/release-notes/2.0.0.rst create mode 100644 docs/source/release-notes/2.1.0.rst create mode 100644 docs/source/release-notes/2.2.0.rst create mode 100644 docs/source/release-notes/2.2.1.rst create mode 100644 docs/source/release-notes/2.2.2.rst create mode 100644 docs/source/release-notes/2.2.3.rst create mode 100644 docs/source/release-notes/2.2.4.rst create mode 100644 docs/source/release-notes/2.2.5.rst create mode 100644 docs/source/release-notes/2.3.0.rst create mode 100644 docs/source/release-notes/2.4.0.rst create mode 100644 docs/source/release-notes/2.4.1.rst create mode 100644 docs/source/release-notes/2.5.0.rst create mode 100644 docs/source/release-notes/2.5.1.rst create mode 100644 docs/source/release-notes/2.5.2.rst create mode 100644 docs/source/release-notes/2.5.3.rst create mode 100644 docs/source/release-notes/2.5.4.rst create mode 100644 docs/source/release-notes/2.5.5.rst create mode 100644 docs/source/release-notes/index.rst diff --git a/docs/source/index.rst b/docs/source/index.rst index 71b3c94..3343801 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -90,6 +90,14 @@ Developer Guide internal/index +Release Notes and History +========================= + +.. toctree:: + :maxdepth: 2 + + release-notes/index + Indices and tables ================== diff --git a/docs/source/release-notes/0.6.0.rst b/docs/source/release-notes/0.6.0.rst new file mode 100644 index 0000000..16590fa --- /dev/null +++ b/docs/source/release-notes/0.6.0.rst @@ -0,0 +1,4 @@ +0.6 - 2010-02-15 +---------------- + +- Fix the McCabe metric on some loops diff --git a/docs/source/release-notes/0.7.0.rst b/docs/source/release-notes/0.7.0.rst new file mode 100644 index 0000000..f842060 --- /dev/null +++ b/docs/source/release-notes/0.7.0.rst @@ -0,0 +1,6 @@ +0.7 - 2010-02-18 +---------------- + +- Fix pep8 initialization when run through Hg +- Make pep8 short options work when run through the command line +- Skip duplicates when controlling files via Hg diff --git a/docs/source/release-notes/0.8.0.rst b/docs/source/release-notes/0.8.0.rst new file mode 100644 index 0000000..66b90b5 --- /dev/null +++ b/docs/source/release-notes/0.8.0.rst @@ -0,0 +1,5 @@ +0.8 - 2011-02-27 +---------------- + +- fixed hg hook +- discard unexisting files on hook check diff --git a/docs/source/release-notes/0.9.0.rst b/docs/source/release-notes/0.9.0.rst new file mode 100644 index 0000000..be6c41b --- /dev/null +++ b/docs/source/release-notes/0.9.0.rst @@ -0,0 +1,5 @@ +0.9 - 2011-11-09 +---------------- + +- update pep8 version to 0.6.1 +- mccabe check: gracefully handle compile failure diff --git a/docs/source/release-notes/1.0.0.rst b/docs/source/release-notes/1.0.0.rst new file mode 100644 index 0000000..6882a43 --- /dev/null +++ b/docs/source/release-notes/1.0.0.rst @@ -0,0 +1,5 @@ +1.0 - 2011-11-29 +---------------- + +- Deactivates by default the complexity checker +- Introduces the complexity option in the HG hook and the command line. diff --git a/docs/source/release-notes/1.1.0.rst b/docs/source/release-notes/1.1.0.rst new file mode 100644 index 0000000..dadbe2e --- /dev/null +++ b/docs/source/release-notes/1.1.0.rst @@ -0,0 +1,8 @@ +1.1 - 2012-02-14 +---------------- + +- fixed the value returned by --version +- allow the flake8: header to be more generic +- fixed the "hg hook raises 'physical lines'" bug +- allow three argument form of raise +- now uses setuptools if available, for 'develop' command diff --git a/docs/source/release-notes/1.2.0.rst b/docs/source/release-notes/1.2.0.rst new file mode 100644 index 0000000..de86237 --- /dev/null +++ b/docs/source/release-notes/1.2.0.rst @@ -0,0 +1,6 @@ +1.2 - 2012-02-12 +---------------- + +- added a git hook +- now Python 3 compatible +- mccabe and pyflakes have warning codes like pep8 now diff --git a/docs/source/release-notes/1.3.0.rst b/docs/source/release-notes/1.3.0.rst new file mode 100644 index 0000000..0ddfe78 --- /dev/null +++ b/docs/source/release-notes/1.3.0.rst @@ -0,0 +1,4 @@ +1.3 - 2012-03-12 +---------------- + +- fixed false W402 warning on exception blocks. diff --git a/docs/source/release-notes/1.3.1.rst b/docs/source/release-notes/1.3.1.rst new file mode 100644 index 0000000..b2e34ee --- /dev/null +++ b/docs/source/release-notes/1.3.1.rst @@ -0,0 +1,4 @@ +1.3.1 - 2012-05-19 +------------------ + +- fixed support for Python 2.5 diff --git a/docs/source/release-notes/1.4.0.rst b/docs/source/release-notes/1.4.0.rst new file mode 100644 index 0000000..51f34cf --- /dev/null +++ b/docs/source/release-notes/1.4.0.rst @@ -0,0 +1,5 @@ +1.4 - 2012-07-12 +---------------- + +- git_hook: Only check staged changes for compliance +- use pep8 1.2 diff --git a/docs/source/release-notes/1.5.0.rst b/docs/source/release-notes/1.5.0.rst new file mode 100644 index 0000000..cd0a88d --- /dev/null +++ b/docs/source/release-notes/1.5.0.rst @@ -0,0 +1,9 @@ +1.5 - 2012-10-13 +---------------- + +- fixed the stdin +- make sure mccabe catches the syntax errors as warnings +- pep8 upgrade +- added max_line_length default value +- added Flake8Command and entry points if setuptools is around +- using the setuptools console wrapper when available diff --git a/docs/source/release-notes/1.6.0.rst b/docs/source/release-notes/1.6.0.rst new file mode 100644 index 0000000..658be2f --- /dev/null +++ b/docs/source/release-notes/1.6.0.rst @@ -0,0 +1,14 @@ +1.6 - 2012-11-16 +---------------- + +- changed the signatures of the ``check_file`` function in flake8/run.py, + ``skip_warning`` in flake8/util.py and the ``check``, ``checkPath`` + functions in flake8/pyflakes.py. +- fix ``--exclude`` and ``--ignore`` command flags (#14, #19) +- fix the git hook that wasn't catching files not already added to the index + (#29) +- pre-emptively includes the addition to pep8 to ignore certain lines. + Add ``# nopep8`` to the end of a line to ignore it. (#37) +- ``check_file`` can now be used without any special prior setup (#21) +- unpacking exceptions will no longer cause an exception (#20) +- fixed crash on non-existent file (#38) diff --git a/docs/source/release-notes/1.6.1.rst b/docs/source/release-notes/1.6.1.rst new file mode 100644 index 0000000..194dfa5 --- /dev/null +++ b/docs/source/release-notes/1.6.1.rst @@ -0,0 +1,7 @@ +1.6.1 - 2012-11-24 +------------------ + +- fixed the mercurial hook, a change from a previous patch was not properly + applied +- fixed an assumption about warnings/error messages that caused an exception + to be thrown when McCabe is used diff --git a/docs/source/release-notes/1.6.2.rst b/docs/source/release-notes/1.6.2.rst new file mode 100644 index 0000000..64633bd --- /dev/null +++ b/docs/source/release-notes/1.6.2.rst @@ -0,0 +1,4 @@ +1.6.2 - 2012-11-25 +------------------ + +- fixed the NameError: global name 'message' is not defined (#46) diff --git a/docs/source/release-notes/1.7.0.rst b/docs/source/release-notes/1.7.0.rst new file mode 100644 index 0000000..a3a4725 --- /dev/null +++ b/docs/source/release-notes/1.7.0.rst @@ -0,0 +1,9 @@ +1.7.0 - 2012-12-21 +------------------ + +- Fixes part of #35: Exception for no WITHITEM being an attribute of Checker + for Python 3.3 +- Support stdin +- Incorporate @phd's builtins pull request +- Fix the git hook +- Update pep8.py to the latest version diff --git a/docs/source/release-notes/2.0.0.rst b/docs/source/release-notes/2.0.0.rst new file mode 100644 index 0000000..4c1ff04 --- /dev/null +++ b/docs/source/release-notes/2.0.0.rst @@ -0,0 +1,13 @@ +2.0.0 - 2013-02-23 +------------------ + +- Pyflakes errors are prefixed by an ``F`` instead of an ``E`` +- McCabe complexity warnings are prefixed by a ``C`` instead of a ``W`` +- Flake8 supports extensions through entry points +- Due to the above support, we **require** setuptools +- We publish the `documentation `_ +- Fixes #13: pep8, pyflakes and mccabe become external dependencies +- Split run.py into main.py, engine.py and hooks.py for better logic +- Expose our parser for our users +- New feature: Install git and hg hooks automagically +- By relying on pyflakes (0.6.1), we also fixed #45 and #35 diff --git a/docs/source/release-notes/2.1.0.rst b/docs/source/release-notes/2.1.0.rst new file mode 100644 index 0000000..c9e3c60 --- /dev/null +++ b/docs/source/release-notes/2.1.0.rst @@ -0,0 +1,12 @@ +2.1.0 - 2013-10-26 +------------------ + +- Add FLAKE8_LAZY and FLAKE8_IGNORE environment variable support to git and + mercurial hooks +- Force git and mercurial hooks to repsect configuration in setup.cfg +- Only check staged files if that is specified +- Fix hook file permissions +- Fix the git hook on python 3 +- Ignore non-python files when running the git hook +- Ignore .tox directories by default +- Flake8 now reports the column number for PyFlakes messages diff --git a/docs/source/release-notes/2.2.0.rst b/docs/source/release-notes/2.2.0.rst new file mode 100644 index 0000000..357b6d2 --- /dev/null +++ b/docs/source/release-notes/2.2.0.rst @@ -0,0 +1,12 @@ +2.2.0 - 2014-06-22 +------------------ + +- New option ``doctests`` to run Pyflakes checks on doctests too +- New option ``jobs`` to launch multiple jobs in parallel +- Turn on using multiple jobs by default using the CPU count +- Add support for ``python -m flake8`` on Python 2.7 and Python 3 +- Fix Git and Mercurial hooks: issues #88, #133, #148 and #149 +- Fix crashes with Python 3.4 by upgrading dependencies +- Fix traceback when running tests with Python 2.6 +- Fix the setuptools command ``python setup.py flake8`` to read + the project configuration diff --git a/docs/source/release-notes/2.2.1.rst b/docs/source/release-notes/2.2.1.rst new file mode 100644 index 0000000..5575f8f --- /dev/null +++ b/docs/source/release-notes/2.2.1.rst @@ -0,0 +1,5 @@ +2.2.1 - 2014-06-30 +------------------ + +- Turn off multiple jobs by default. To enable automatic use of all CPUs, use + ``--jobs=auto``. Fixes #155 and #154. diff --git a/docs/source/release-notes/2.2.2.rst b/docs/source/release-notes/2.2.2.rst new file mode 100644 index 0000000..8fcff88 --- /dev/null +++ b/docs/source/release-notes/2.2.2.rst @@ -0,0 +1,5 @@ +2.2.2 - 2014-07-04 +------------------ + +- Re-enable multiprocessing by default while fixing the issue Windows users + were seeing. diff --git a/docs/source/release-notes/2.2.3.rst b/docs/source/release-notes/2.2.3.rst new file mode 100644 index 0000000..e7430f0 --- /dev/null +++ b/docs/source/release-notes/2.2.3.rst @@ -0,0 +1,4 @@ +2.2.3 - 2014-08-25 +------------------ + +- Actually turn multiprocessing on by default diff --git a/docs/source/release-notes/2.2.4.rst b/docs/source/release-notes/2.2.4.rst new file mode 100644 index 0000000..2564948 --- /dev/null +++ b/docs/source/release-notes/2.2.4.rst @@ -0,0 +1,20 @@ +2.2.4 - 2014-10-09 +------------------ + +- Fix bugs triggered by turning multiprocessing on by default (again) + + Multiprocessing is forcibly disabled in the following cases: + + - Passing something in via stdin + + - Analyzing a diff + + - Using windows + +- Fix --install-hook when there are no config files present for pep8 or + flake8. + +- Fix how the setuptools command parses excludes in config files + +- Fix how the git hook determines which files to analyze (Thanks Chris + Buccella!) diff --git a/docs/source/release-notes/2.2.5.rst b/docs/source/release-notes/2.2.5.rst new file mode 100644 index 0000000..540278f --- /dev/null +++ b/docs/source/release-notes/2.2.5.rst @@ -0,0 +1,6 @@ +2.2.5 - 2014-10-19 +------------------ + +- Flush standard out when using multiprocessing + +- Make the check for "# flake8: noqa" more strict diff --git a/docs/source/release-notes/2.3.0.rst b/docs/source/release-notes/2.3.0.rst new file mode 100644 index 0000000..120efa9 --- /dev/null +++ b/docs/source/release-notes/2.3.0.rst @@ -0,0 +1,10 @@ +2.3.0 - 2015-01-04 +------------------ + +- **Feature**: Add ``--output-file`` option to specify a file to write to + instead of ``stdout``. + +- **Bug** Fix interleaving of output while using multiprocessing + (`GitLab#17`_) + +.. _GitLab#17: https://gitlab.com/pycqa/flake8/issues/17 diff --git a/docs/source/release-notes/2.4.0.rst b/docs/source/release-notes/2.4.0.rst new file mode 100644 index 0000000..6c470cd --- /dev/null +++ b/docs/source/release-notes/2.4.0.rst @@ -0,0 +1,33 @@ +2.4.0 - 2015-03-07 +------------------ + +- **Bug** Print filenames when using multiprocessing and ``-q`` option. + (`GitLab#31`_) + +- **Bug** Put upper cap on dependencies. The caps for 2.4.0 are: + + - ``pep8 < 1.6`` (Related to `GitLab#35`_) + + - ``mccabe < 0.4`` + + - ``pyflakes < 0.9`` + + See also `GitLab#32`_ + +- **Bug** Files excluded in a config file were not being excluded when flake8 + was run from a git hook. (`GitHub#2`_) + +- **Improvement** Print warnings for users who are providing mutually + exclusive options to flake8. (`GitLab#8`_, `GitLab!18`_) + +- **Feature** Allow git hook configuration to live in ``.git/config``. + See the updated `VCS hooks docs`_ for more details. (`GitLab!20`_) + +.. _GitHub#2: https://github.com/pycqa/flake8/pull/2 +.. _GitLab#8: https://gitlab.com/pycqa/flake8/issues/8 +.. _GitLab#31: https://gitlab.com/pycqa/flake8/issues/31 +.. _GitLab#32: https://gitlab.com/pycqa/flake8/issues/32 +.. _GitLab#35: https://gitlab.com/pycqa/flake8/issues/35 +.. _GitLab!18: https://gitlab.com/pycqa/flake8/merge_requests/18 +.. _GitLab!20: https://gitlab.com/pycqa/flake8/merge_requests/20 +.. _VCS hooks docs: https://flake8.readthedocs.org/en/latest/vcs.html diff --git a/docs/source/release-notes/2.4.1.rst b/docs/source/release-notes/2.4.1.rst new file mode 100644 index 0000000..3448bc4 --- /dev/null +++ b/docs/source/release-notes/2.4.1.rst @@ -0,0 +1,12 @@ +2.4.1 - 2015-05-18 +------------------ + +- **Bug** Do not raise a ``SystemError`` unless there were errors in the + setuptools command. (`GitLab#39`_, `GitLab!23`_) + +- **Bug** Do not verify dependencies of extensions loaded via entry-points. + +- **Improvement** Blacklist versions of pep8 we know are broken + +.. _GitLab#39: https://gitlab.com/pycqa/flake8/issues/39 +.. _GitLab!23: https://gitlab.com/pycqa/flake8/merge_requests/23 diff --git a/docs/source/release-notes/2.5.0.rst b/docs/source/release-notes/2.5.0.rst new file mode 100644 index 0000000..1558fcf --- /dev/null +++ b/docs/source/release-notes/2.5.0.rst @@ -0,0 +1,25 @@ +2.5.0 - 2015-10-26 +------------------ + +- **Improvement** Raise cap on PyFlakes for Python 3.5 support + +- **Improvement** Avoid deprecation warnings when loading extensions + (`GitLab#59`_, `GitLab#90`_) + +- **Improvement** Separate logic to enable "off-by-default" extensions + (`GitLab#67`_) + +- **Bug** Properly parse options to setuptools Flake8 command (`GitLab!41`_) + +- **Bug** Fix exceptions when output on stdout is truncated before Flake8 + finishes writing the output (`GitLab#69`_) + +- **Bug** Fix error on OS X where Flake8 can no longer acquire or create new + semaphores (`GitLab#74`_) + +.. _GitLab!41: https://gitlab.com/pycqa/flake8/merge_requests/41 +.. _GitLab#59: https://gitlab.com/pycqa/flake8/issues/59 +.. _GitLab#67: https://gitlab.com/pycqa/flake8/issues/67 +.. _GitLab#69: https://gitlab.com/pycqa/flake8/issues/69 +.. _GitLab#74: https://gitlab.com/pycqa/flake8/issues/74 +.. _GitLab#90: https://gitlab.com/pycqa/flake8/issues/90 diff --git a/docs/source/release-notes/2.5.1.rst b/docs/source/release-notes/2.5.1.rst new file mode 100644 index 0000000..8a114c8 --- /dev/null +++ b/docs/source/release-notes/2.5.1.rst @@ -0,0 +1,13 @@ +2.5.1 - 2015-12-08 +------------------ + +- **Bug** Properly look for ``.flake8`` in current working directory + (`GitLab#103`_) + +- **Bug** Monkey-patch ``pep8.stdin_get_value`` to cache the actual value in + stdin. This helps plugins relying on the function when run with + multiprocessing. (`GitLab#105`_, `GitLab#107`_) + +.. _GitLab#103: https://gitlab.com/pycqa/flake8/issues/103 +.. _GitLab#105: https://gitlab.com/pycqa/flake8/issues/105 +.. _GitLab#107: https://gitlab.com/pycqa/flake8/issues/107 diff --git a/docs/source/release-notes/2.5.2.rst b/docs/source/release-notes/2.5.2.rst new file mode 100644 index 0000000..a093c9f --- /dev/null +++ b/docs/source/release-notes/2.5.2.rst @@ -0,0 +1,7 @@ +2.5.2 - 2016-01-30 +------------------ + +- **Bug** Parse ``output_file`` and ``enable_extensions`` from config files + +- **Improvement** Raise upper bound on mccabe plugin to allow for version + 0.4.0 diff --git a/docs/source/release-notes/2.5.3.rst b/docs/source/release-notes/2.5.3.rst new file mode 100644 index 0000000..85dbf33 --- /dev/null +++ b/docs/source/release-notes/2.5.3.rst @@ -0,0 +1,5 @@ +2.5.3 - 2016-02-11 +------------------ + +- **Bug** Actually parse ``output_file`` and ``enable_extensions`` from config + files diff --git a/docs/source/release-notes/2.5.4.rst b/docs/source/release-notes/2.5.4.rst new file mode 100644 index 0000000..5ba03ba --- /dev/null +++ b/docs/source/release-notes/2.5.4.rst @@ -0,0 +1,4 @@ +2.5.4 - 2016-02-11 +------------------ + +- **Bug** Missed an attribute rename during the v2.5.3 release. diff --git a/docs/source/release-notes/2.5.5.rst b/docs/source/release-notes/2.5.5.rst new file mode 100644 index 0000000..683cfb6 --- /dev/null +++ b/docs/source/release-notes/2.5.5.rst @@ -0,0 +1,7 @@ +2.5.5 - 2016-06-14 +------------------ + +- **Bug** Fix setuptools integration when parsing config files + +- **Bug** Don't pass the user's config path as the config_file when creating a + StyleGuide diff --git a/docs/source/release-notes/index.rst b/docs/source/release-notes/index.rst new file mode 100644 index 0000000..aef67e9 --- /dev/null +++ b/docs/source/release-notes/index.rst @@ -0,0 +1,40 @@ +=========================== + Release Notes and History +=========================== + +All of the release notes that have been recorded for Flake8 are organized here +with the newest releases first. + +.. toctree:: + 2.5.5 + 2.5.4 + 2.5.3 + 2.5.2 + 2.5.1 + 2.5.0 + 2.4.1 + 2.4.0 + 2.3.0 + 2.2.5 + 2.2.4 + 2.2.3 + 2.2.2 + 2.2.1 + 2.2.0 + 2.1.0 + 2.0.0 + 1.7.0 + 1.6.2 + 1.6.1 + 1.6.0 + 1.5.0 + 1.4.0 + 1.3.1 + 1.3.0 + 1.2.0 + 1.1.0 + 1.0.0 + 0.9.0 + 0.8.0 + 0.7.0 + 0.6.0