diff options
| author | Brian Grohe <grohe43@gmail.com> | 2023-04-24 17:46:37 +0000 |
|---|---|---|
| committer | Ned Batchelder <ned@nedbatchelder.com> | 2023-04-25 08:42:05 -0600 |
| commit | c6610b30e8f01f6107e0fce07eca35c04b1c09ce (patch) | |
| tree | 8e0b6071b93f92c3b0215608f906ecbde4961c92 | |
| parent | 84e43c402fb429c7aa0432dc46229158fb5e1889 (diff) | |
| download | python-coveragepy-git-c6610b30e8f01f6107e0fce07eca35c04b1c09ce.tar.gz | |
docs: a new page about migrating between versions
Added basic migraton docs changes
Remove change that likely will not require migration changes
Cannot determine what the behavior was before
Updated ** replacement suggestion
Remove extra indent at end of file
Fix linting issue that needed a trailing indent
Fix a typo in docs
Removed .gitignore corrected a single rule
Added basic migraton docs changes
Fix linting issue that needed a trailing indent
Fix a typo in docs
Correct grammar issue
Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
Correct rule and spelling
Remove personal gitignore config
Removed duplicated license text
Added extra space
Take suggestions from ned
Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
| -rw-r--r-- | doc/index.rst | 1 | ||||
| -rw-r--r-- | doc/migrations.rst | 26 |
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. |