summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--doc/index.rst1
-rw-r--r--doc/migrations.rst26
2 files changed, 27 insertions, 0 deletions
diff --git a/doc/index.rst b/doc/index.rst
index b11dc90e..30ddf88b 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -234,4 +234,5 @@ More information
trouble
faq
Change history <changes>
+ Migrating version notes <migrations>
sleepy
diff --git a/doc/migrations.rst b/doc/migrations.rst
new file mode 100644
index 00000000..e618cdc0
--- /dev/null
+++ b/doc/migrations.rst
@@ -0,0 +1,26 @@
+.. 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.