From 42c82c75f0551bda0ac160de315655149c28783c Mon Sep 17 00:00:00 2001 From: Brian Grohe Date: Mon, 24 Apr 2023 17:46:37 +0000 Subject: [PATCH 01/21] Created basic migration file --- doc/index.rst | 1 + doc/migrations.rst | 11 +++++++++++ 2 files changed, 12 insertions(+) create mode 100644 doc/migrations.rst diff --git a/doc/index.rst b/doc/index.rst index b11dc90e9..30ddf88b4 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -234,4 +234,5 @@ More information trouble faq Change history + Migrating version notes sleepy diff --git a/doc/migrations.rst b/doc/migrations.rst new file mode 100644 index 000000000..ae9d545d9 --- /dev/null +++ b/doc/migrations.rst @@ -0,0 +1,11 @@ +.. Licensed under the Apache License: http://www.apache.org/licenses/LICENSE-2.0 +.. For details: https://github.com/nedbat/coveragepy/blob/master/NOTICE.txt + +.. 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 instructions between versions +================================================ From 9bb3321cbd3b453893aadabd7a79661f7a444e5c Mon Sep 17 00:00:00 2001 From: Brian Grohe Date: Mon, 24 Apr 2023 12:50:20 -0600 Subject: [PATCH 02/21] Added basic migraton docs changes --- .gitignore | 1 + doc/migrations.rst | 24 +++++++++++++++++++++--- 2 files changed, 22 insertions(+), 3 deletions(-) diff --git a/.gitignore b/.gitignore index a49767e77..6c6aec881 100644 --- a/.gitignore +++ b/.gitignore @@ -52,3 +52,4 @@ tmp .DS_Store !.github +.devcontainer/devcontainer.json diff --git a/doc/migrations.rst b/doc/migrations.rst index ae9d545d9..6177ce8be 100644 --- a/doc/migrations.rst +++ b/doc/migrations.rst @@ -6,6 +6,24 @@ .. _migrations: -================================================ -Migrating instructions between versions -================================================ +============================== +Migrating between versions +============================== + +.. _migrating_6x_7x: + +Migrating 6.x.x — 7.x.x +-------------------------- +- The way that wildcards when specifing file paths work in certain caseshas changed in 7.x: + + - Previously, ``*`` would incorrectly match directory separators, making + precise matching difficult. This requires ``[paths]`` such as ``*tests/*`` + to be changed to ``*/tests/*``. + + - A file path setting like ``*/foo`` will now match ``foo/bar.py`` so that + relative file paths can be combined more easily. + +- 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. + From 2f17d2ce5ad3fe6ea316b426d9acb5b9afb76619 Mon Sep 17 00:00:00 2001 From: Brian Grohe Date: Mon, 24 Apr 2023 12:59:05 -0600 Subject: [PATCH 03/21] Remove change that likely will not require migration changes Cannot determine what the behavior was before --- doc/migrations.rst | 3 --- 1 file changed, 3 deletions(-) diff --git a/doc/migrations.rst b/doc/migrations.rst index 6177ce8be..85514863f 100644 --- a/doc/migrations.rst +++ b/doc/migrations.rst @@ -19,9 +19,6 @@ Migrating 6.x.x — 7.x.x - Previously, ``*`` would incorrectly match directory separators, making precise matching difficult. This requires ``[paths]`` such as ``*tests/*`` to be changed to ``*/tests/*``. - - - A file path setting like ``*/foo`` will now match ``foo/bar.py`` so that - relative file paths can be combined more easily. - When remapping file paths with ``[paths]``, a path will be remapped only if the resulting path exists. Ensure that remapped ``[paths]`` exist when upgrading From 2df76000c973fd639158d5973fa6a07744cf3c4e Mon Sep 17 00:00:00 2001 From: Brian Grohe Date: Mon, 24 Apr 2023 14:55:12 -0600 Subject: [PATCH 04/21] Updated ** replacement suggestion --- doc/migrations.rst | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/doc/migrations.rst b/doc/migrations.rst index 85514863f..c55e867e3 100644 --- a/doc/migrations.rst +++ b/doc/migrations.rst @@ -12,7 +12,7 @@ Migrating between versions .. _migrating_6x_7x: -Migrating 6.x.x — 7.x.x +Migrating 6.5.x — 7.0.x -------------------------- - The way that wildcards when specifing file paths work in certain caseshas changed in 7.x: @@ -20,6 +20,9 @@ Migrating 6.x.x — 7.x.x precise matching difficult. This requires ``[paths]`` such as ``*tests/*`` 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. From bdad5bc4832803a80766ff2f5572a4f6101e76a6 Mon Sep 17 00:00:00 2001 From: Brian Grohe Date: Mon, 24 Apr 2023 15:17:50 -0600 Subject: [PATCH 05/21] Remove extra indent at end of file --- doc/migrations.rst | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/doc/migrations.rst b/doc/migrations.rst index c55e867e3..903f6745e 100644 --- a/doc/migrations.rst +++ b/doc/migrations.rst @@ -14,10 +14,10 @@ Migrating between versions Migrating 6.5.x — 7.0.x -------------------------- -- The way that wildcards when specifing file paths work in certain caseshas changed in 7.x: +- The way that wildcards when specifing file paths work in certain caseshas changed in 7.0.x: - Previously, ``*`` would incorrectly match directory separators, making - precise matching difficult. This requires ``[paths]`` such as ``*tests/*`` + precise matching difficult. This requires patterns such as ``*tests/*`` to be changed to ``*/tests/*``. - ``**`` now matches any number of nested directories. If you wish to retain the behavior of @@ -26,4 +26,3 @@ Migrating 6.5.x — 7.0.x - 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. - From a38d0662bf6f98fe859fb2638df4c23800136223 Mon Sep 17 00:00:00 2001 From: Brian Grohe Date: Mon, 24 Apr 2023 15:51:52 -0600 Subject: [PATCH 06/21] Fix linting issue that needed a trailing indent --- doc/migrations.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/migrations.rst b/doc/migrations.rst index 903f6745e..5ae941c1b 100644 --- a/doc/migrations.rst +++ b/doc/migrations.rst @@ -21,7 +21,7 @@ Migrating 6.5.x — 7.0.x 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. + ``**/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 From 082815a777a2f6db94d1d9b41a3412108441029a Mon Sep 17 00:00:00 2001 From: Brian Grohe Date: Mon, 24 Apr 2023 15:55:44 -0600 Subject: [PATCH 07/21] Fix a typo in docs --- doc/migrations.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/migrations.rst b/doc/migrations.rst index 5ae941c1b..2cf5addb3 100644 --- a/doc/migrations.rst +++ b/doc/migrations.rst @@ -14,7 +14,7 @@ Migrating between versions Migrating 6.5.x — 7.0.x -------------------------- -- The way that wildcards when specifing file paths work in certain caseshas changed in 7.0.x: +- The way that wildcards when specifing file paths work in certain cases as changed in 7.0.x: - Previously, ``*`` would incorrectly match directory separators, making precise matching difficult. This requires patterns such as ``*tests/*`` From 9903d0c530d68405b31a19208479232626bda67d Mon Sep 17 00:00:00 2001 From: Brian Grohe Date: Mon, 24 Apr 2023 17:46:37 +0000 Subject: [PATCH 08/21] Created basic migration file --- doc/index.rst | 1 + doc/migrations.rst | 11 +++++++++++ 2 files changed, 12 insertions(+) create mode 100644 doc/migrations.rst diff --git a/doc/index.rst b/doc/index.rst index b11dc90e9..30ddf88b4 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -234,4 +234,5 @@ More information trouble faq Change history + Migrating version notes sleepy diff --git a/doc/migrations.rst b/doc/migrations.rst new file mode 100644 index 000000000..ae9d545d9 --- /dev/null +++ b/doc/migrations.rst @@ -0,0 +1,11 @@ +.. Licensed under the Apache License: http://www.apache.org/licenses/LICENSE-2.0 +.. For details: https://github.com/nedbat/coveragepy/blob/master/NOTICE.txt + +.. 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 instructions between versions +================================================ From b7dffef76ecd435b8e341f64086c6a2189415f7b Mon Sep 17 00:00:00 2001 From: Brian Grohe Date: Mon, 24 Apr 2023 12:50:20 -0600 Subject: [PATCH 09/21] Added basic migraton docs changes --- .gitignore | 1 + doc/migrations.rst | 24 +++++++++++++++++++++--- 2 files changed, 22 insertions(+), 3 deletions(-) diff --git a/.gitignore b/.gitignore index a49767e77..6c6aec881 100644 --- a/.gitignore +++ b/.gitignore @@ -52,3 +52,4 @@ tmp .DS_Store !.github +.devcontainer/devcontainer.json diff --git a/doc/migrations.rst b/doc/migrations.rst index ae9d545d9..6177ce8be 100644 --- a/doc/migrations.rst +++ b/doc/migrations.rst @@ -6,6 +6,24 @@ .. _migrations: -================================================ -Migrating instructions between versions -================================================ +============================== +Migrating between versions +============================== + +.. _migrating_6x_7x: + +Migrating 6.x.x — 7.x.x +-------------------------- +- The way that wildcards when specifing file paths work in certain caseshas changed in 7.x: + + - Previously, ``*`` would incorrectly match directory separators, making + precise matching difficult. This requires ``[paths]`` such as ``*tests/*`` + to be changed to ``*/tests/*``. + + - A file path setting like ``*/foo`` will now match ``foo/bar.py`` so that + relative file paths can be combined more easily. + +- 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. + From 9587a98cb6a884aa9dbbcc709821b02094af1e65 Mon Sep 17 00:00:00 2001 From: Brian Grohe Date: Mon, 24 Apr 2023 12:59:05 -0600 Subject: [PATCH 10/21] Remove change that likely will not require migration changes Cannot determine what the behavior was before --- doc/migrations.rst | 3 --- 1 file changed, 3 deletions(-) diff --git a/doc/migrations.rst b/doc/migrations.rst index 6177ce8be..85514863f 100644 --- a/doc/migrations.rst +++ b/doc/migrations.rst @@ -19,9 +19,6 @@ Migrating 6.x.x — 7.x.x - Previously, ``*`` would incorrectly match directory separators, making precise matching difficult. This requires ``[paths]`` such as ``*tests/*`` to be changed to ``*/tests/*``. - - - A file path setting like ``*/foo`` will now match ``foo/bar.py`` so that - relative file paths can be combined more easily. - When remapping file paths with ``[paths]``, a path will be remapped only if the resulting path exists. Ensure that remapped ``[paths]`` exist when upgrading From 9905e598f659dca52933a1a97071da75c0cd2db0 Mon Sep 17 00:00:00 2001 From: Brian Grohe Date: Mon, 24 Apr 2023 14:55:12 -0600 Subject: [PATCH 11/21] Updated ** replacement suggestion --- doc/migrations.rst | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/doc/migrations.rst b/doc/migrations.rst index 85514863f..c55e867e3 100644 --- a/doc/migrations.rst +++ b/doc/migrations.rst @@ -12,7 +12,7 @@ Migrating between versions .. _migrating_6x_7x: -Migrating 6.x.x — 7.x.x +Migrating 6.5.x — 7.0.x -------------------------- - The way that wildcards when specifing file paths work in certain caseshas changed in 7.x: @@ -20,6 +20,9 @@ Migrating 6.x.x — 7.x.x precise matching difficult. This requires ``[paths]`` such as ``*tests/*`` 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. From cf4f12f3f4bf05dbb309d24c7e92c85189e06656 Mon Sep 17 00:00:00 2001 From: Brian Grohe Date: Mon, 24 Apr 2023 15:17:50 -0600 Subject: [PATCH 12/21] Remove extra indent at end of file --- doc/migrations.rst | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/doc/migrations.rst b/doc/migrations.rst index c55e867e3..903f6745e 100644 --- a/doc/migrations.rst +++ b/doc/migrations.rst @@ -14,10 +14,10 @@ Migrating between versions Migrating 6.5.x — 7.0.x -------------------------- -- The way that wildcards when specifing file paths work in certain caseshas changed in 7.x: +- The way that wildcards when specifing file paths work in certain caseshas changed in 7.0.x: - Previously, ``*`` would incorrectly match directory separators, making - precise matching difficult. This requires ``[paths]`` such as ``*tests/*`` + precise matching difficult. This requires patterns such as ``*tests/*`` to be changed to ``*/tests/*``. - ``**`` now matches any number of nested directories. If you wish to retain the behavior of @@ -26,4 +26,3 @@ Migrating 6.5.x — 7.0.x - 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. - From 55c6a802db0cd7e7bf83326c261bd877236cc41e Mon Sep 17 00:00:00 2001 From: Brian Grohe Date: Mon, 24 Apr 2023 15:51:52 -0600 Subject: [PATCH 13/21] Fix linting issue that needed a trailing indent --- doc/migrations.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/migrations.rst b/doc/migrations.rst index 903f6745e..5ae941c1b 100644 --- a/doc/migrations.rst +++ b/doc/migrations.rst @@ -21,7 +21,7 @@ Migrating 6.5.x — 7.0.x 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. + ``**/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 From 9e0ee9cf60f6ee5be3e5ae76f79311e02d71b8ae Mon Sep 17 00:00:00 2001 From: Brian Grohe Date: Mon, 24 Apr 2023 15:55:44 -0600 Subject: [PATCH 14/21] Fix a typo in docs --- doc/migrations.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/migrations.rst b/doc/migrations.rst index 5ae941c1b..2cf5addb3 100644 --- a/doc/migrations.rst +++ b/doc/migrations.rst @@ -14,7 +14,7 @@ Migrating between versions Migrating 6.5.x — 7.0.x -------------------------- -- The way that wildcards when specifing file paths work in certain caseshas changed in 7.0.x: +- The way that wildcards when specifing file paths work in certain cases as changed in 7.0.x: - Previously, ``*`` would incorrectly match directory separators, making precise matching difficult. This requires patterns such as ``*tests/*`` From f5c362da269e7074a6bb85d7fbe402689fd11c6d Mon Sep 17 00:00:00 2001 From: Brian Grohe Date: Mon, 24 Apr 2023 17:26:31 -0600 Subject: [PATCH 15/21] Correct grammar issue Co-authored-by: Ned Batchelder --- doc/migrations.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/migrations.rst b/doc/migrations.rst index 2cf5addb3..84abcd025 100644 --- a/doc/migrations.rst +++ b/doc/migrations.rst @@ -14,7 +14,7 @@ Migrating between versions Migrating 6.5.x — 7.0.x -------------------------- -- The way that wildcards when specifing file paths work in certain cases as changed in 7.0.x: +- The way that wildcards when specifing file paths work in certain cases has changed in 7.0.x: - Previously, ``*`` would incorrectly match directory separators, making precise matching difficult. This requires patterns such as ``*tests/*`` From aa3b0fde270566fbe42d3e538583c0097b9bf6b9 Mon Sep 17 00:00:00 2001 From: Brian Grohe Date: Mon, 24 Apr 2023 17:27:40 -0600 Subject: [PATCH 16/21] Removed .gitignore corrected a single rule --- .gitignore | 1 - doc/migrations.rst | 4 ++-- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/.gitignore b/.gitignore index 6c6aec881..a49767e77 100644 --- a/.gitignore +++ b/.gitignore @@ -52,4 +52,3 @@ tmp .DS_Store !.github -.devcontainer/devcontainer.json diff --git a/doc/migrations.rst b/doc/migrations.rst index 2cf5addb3..2561bd5ac 100644 --- a/doc/migrations.rst +++ b/doc/migrations.rst @@ -6,9 +6,9 @@ .. _migrations: -============================== +========================== Migrating between versions -============================== +========================== .. _migrating_6x_7x: From 448850cb2abfcd0734f6b712f15518109dc01756 Mon Sep 17 00:00:00 2001 From: Brian Grohe Date: Mon, 24 Apr 2023 17:32:58 -0600 Subject: [PATCH 17/21] Correct rule and spelling --- doc/migrations.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/migrations.rst b/doc/migrations.rst index 8e616718e..20d05dfb5 100644 --- a/doc/migrations.rst +++ b/doc/migrations.rst @@ -13,8 +13,8 @@ Migrating between versions .. _migrating_6x_7x: Migrating 6.5.x — 7.0.x --------------------------- -- The way that wildcards when specifing 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.0.x: - Previously, ``*`` would incorrectly match directory separators, making precise matching difficult. This requires patterns such as ``*tests/*`` From 5442e239b42ae8fb0b00599188578b6bfd369ca6 Mon Sep 17 00:00:00 2001 From: Brian Grohe Date: Mon, 24 Apr 2023 17:34:46 -0600 Subject: [PATCH 18/21] Remove personal gitignore config --- .gitignore | 1 - 1 file changed, 1 deletion(-) diff --git a/.gitignore b/.gitignore index 6c6aec881..a49767e77 100644 --- a/.gitignore +++ b/.gitignore @@ -52,4 +52,3 @@ tmp .DS_Store !.github -.devcontainer/devcontainer.json From 2e7e9e3648bd173e9033ce6f09cef1c24d1b259b Mon Sep 17 00:00:00 2001 From: Brian Grohe Date: Mon, 24 Apr 2023 17:37:05 -0600 Subject: [PATCH 19/21] Removed duplicated license text --- doc/migrations.rst | 3 --- 1 file changed, 3 deletions(-) diff --git a/doc/migrations.rst b/doc/migrations.rst index 20d05dfb5..4e97fc84f 100644 --- a/doc/migrations.rst +++ b/doc/migrations.rst @@ -1,9 +1,6 @@ .. Licensed under the Apache License: http://www.apache.org/licenses/LICENSE-2.0 .. For details: https://github.com/nedbat/coveragepy/blob/master/NOTICE.txt -.. 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: ========================== From bdc1622ba0e798a9b2535ca20a70d9722c42b135 Mon Sep 17 00:00:00 2001 From: Brian Grohe Date: Mon, 24 Apr 2023 17:40:03 -0600 Subject: [PATCH 20/21] Added extra space --- doc/migrations.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/migrations.rst b/doc/migrations.rst index 4e97fc84f..df52bb0f3 100644 --- a/doc/migrations.rst +++ b/doc/migrations.rst @@ -11,6 +11,7 @@ Migrating between versions 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 From 5b4353349ed2f49d1806232bf6fe58c29c1ac98e Mon Sep 17 00:00:00 2001 From: Brian Grohe Date: Mon, 24 Apr 2023 17:41:58 -0600 Subject: [PATCH 21/21] Take suggestions from ned Co-authored-by: Ned Batchelder --- doc/migrations.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/migrations.rst b/doc/migrations.rst index df52bb0f3..e618cdc00 100644 --- a/doc/migrations.rst +++ b/doc/migrations.rst @@ -15,8 +15,8 @@ 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. This requires patterns such as ``*tests/*`` - to be changed to ``*/tests/*``. + 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.