summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNed Batchelder <ned@nedbatchelder.com>2023-04-25 08:51:02 -0600
committerNed Batchelder <ned@nedbatchelder.com>2023-04-25 08:51:02 -0600
commitd6e621aa3f492ffb4f630a914cc79a392afb95a2 (patch)
treee0ee35889bc0c64ce9544239aa9e38e1486b5eae
parentc6610b30e8f01f6107e0fce07eca35c04b1c09ce (diff)
downloadpython-coveragepy-git-d6e621aa3f492ffb4f630a914cc79a392afb95a2.tar.gz
docs: clean up for #1610. Thanks, Brian Grohe.
-rw-r--r--CHANGES.rst5
-rw-r--r--CONTRIBUTORS.txt1
-rw-r--r--doc/index.rst2
-rw-r--r--doc/migrating.rst (renamed from doc/migrations.rst)11
4 files changed, 13 insertions, 6 deletions
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 <migrating>` 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_>`_.
+.. _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 <changes>
- Migrating version notes <migrations>
+ migrating
sleepy
diff --git a/doc/migrations.rst b/doc/migrating.rst
index e618cdc0..7a5e65df 100644
--- a/doc/migrations.rst
+++ b/doc/migrating.rst
@@ -1,18 +1,21 @@
.. 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:
==========================
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 6.5.x — 7.0.x
------------------------
+Migrating from 6.x to 7.x
+-------------------------
-- The way that wildcards when specifying file paths work in certain cases has changed in 7.0.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/*``