From d6e621aa3f492ffb4f630a914cc79a392afb95a2 Mon Sep 17 00:00:00 2001 From: Ned Batchelder Date: Tue, 25 Apr 2023 08:51:02 -0600 Subject: docs: clean up for #1610. Thanks, Brian Grohe. --- CHANGES.rst | 5 ++++- CONTRIBUTORS.txt | 1 + doc/index.rst | 2 +- doc/migrating.rst | 29 +++++++++++++++++++++++++++++ doc/migrations.rst | 26 -------------------------- 5 files changed, 35 insertions(+), 28 deletions(-) create mode 100644 doc/migrating.rst delete mode 100644 doc/migrations.rst diff --git a/CHANGES.rst b/CHANGES.rst index f1555179..ec31b21b 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -20,8 +20,11 @@ development at the same time, such as 4.5.x and 5.0. Unreleased ---------- -Nothing yet. +- Docs: a new :ref:`Migrating page ` with details about how to + migrate between major versions of coverage.py. It currently covers the + wildcard changes in 7.x. Thanks, `Brian Grohe `_. +.. _pull 1610: https://github.com/nedbat/coveragepy/pull/1610 .. scriv-start-here diff --git a/CONTRIBUTORS.txt b/CONTRIBUTORS.txt index 0ba35f62..4d387ef0 100644 --- a/CONTRIBUTORS.txt +++ b/CONTRIBUTORS.txt @@ -32,6 +32,7 @@ Bill Hart Bradley Burns Brandon Rhodes Brett Cannon +Brian Grohe Bruno P. Kinoshita Buck Evan Calen Pennington diff --git a/doc/index.rst b/doc/index.rst index 30ddf88b..2420aa6f 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -234,5 +234,5 @@ More information trouble faq Change history - Migrating version notes + migrating sleepy diff --git a/doc/migrating.rst b/doc/migrating.rst new file mode 100644 index 00000000..7a5e65df --- /dev/null +++ b/doc/migrating.rst @@ -0,0 +1,29 @@ +.. Licensed under the Apache License: http://www.apache.org/licenses/LICENSE-2.0 +.. For details: https://github.com/nedbat/coveragepy/blob/master/NOTICE.txt + +.. _migrating: + +========================== +Migrating between versions +========================== + +New major versions of coverage.py might require you to adjust your settings, +options, or other aspects of your use. This page details those changes. + +.. _migrating_6x_7x: + +Migrating from 6.x to 7.x +------------------------- + +- The way that wildcards when specifying file paths work in certain cases has changed in 7.x: + + - Previously, ``*`` would incorrectly match directory separators, making + precise matching difficult. Patterns such as ``*tests/*`` + will need to be changed to ``*/tests/*``. + + - ``**`` now matches any number of nested directories. If you wish to retain the behavior of + ``**/tests/*`` in previous versions then ``*/**/tests/*`` can be used instead. + +- When remapping file paths with ``[paths]``, a path will be remapped only if + the resulting path exists. Ensure that remapped ``[paths]`` exist when upgrading + as this is now being enforced. diff --git a/doc/migrations.rst b/doc/migrations.rst deleted file mode 100644 index e618cdc0..00000000 --- a/doc/migrations.rst +++ /dev/null @@ -1,26 +0,0 @@ -.. Licensed under the Apache License: http://www.apache.org/licenses/LICENSE-2.0 -.. For details: https://github.com/nedbat/coveragepy/blob/master/NOTICE.txt - -.. _migrations: - -========================== -Migrating between versions -========================== - -.. _migrating_6x_7x: - -Migrating 6.5.x — 7.0.x ------------------------ - -- The way that wildcards when specifying file paths work in certain cases has changed in 7.0.x: - - - Previously, ``*`` would incorrectly match directory separators, making - precise matching difficult. Patterns such as ``*tests/*`` - will need to be changed to ``*/tests/*``. - - - ``**`` now matches any number of nested directories. If you wish to retain the behavior of - ``**/tests/*`` in previous versions then ``*/**/tests/*`` can be used instead. - -- When remapping file paths with ``[paths]``, a path will be remapped only if - the resulting path exists. Ensure that remapped ``[paths]`` exist when upgrading - as this is now being enforced. -- cgit v1.2.1