Mercurial > hgrepos > Python > libs > ConfigMix

annotate docs/changes.rst @ 252:42a6d59cf2ad

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Put a note about the latest breaking change into the appropriate documentation section also
author Franz Glasner <fzglas.hg@dom66.de>
date Wed, 08 Jul 2020 08:52:09 +0200
parents ab3d0326419c
children 16bcd85c7d28
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
192
46c7d872db83 Changelog: note the latest refactorings
Franz Glasner <fzglas.hg@dom66.de>
parents: 176
diff changeset
1 .. -*- coding: utf-8; mode: rst; -*-
91
5ca36fbea43d Created a changelog
Franz Glasner <hg@dom66.de>
parents:
diff changeset
2
5ca36fbea43d Created a changelog
Franz Glasner <hg@dom66.de>
parents:
diff changeset
3 =========
5ca36fbea43d Created a changelog
Franz Glasner <hg@dom66.de>
parents:
diff changeset
4 Changes
5ca36fbea43d Created a changelog
Franz Glasner <hg@dom66.de>
parents:
diff changeset
5 =========
5ca36fbea43d Created a changelog
Franz Glasner <hg@dom66.de>
parents:
diff changeset
6
111
d51a18e5b0e3 Reimplement configmix.safe_merge() do to a deepcopy of all source configurations when merging.
Franz Glasner <hg@dom66.de>
parents: 91
diff changeset
7 All major changes over the versions are listed here. For breaking
91
5ca36fbea43d Created a changelog
Franz Glasner <hg@dom66.de>
parents:
diff changeset
8 changes have a look at :ref:`api-changes`, they are listed there in
5ca36fbea43d Created a changelog
Franz Glasner <hg@dom66.de>
parents:
diff changeset
9 detail.
5ca36fbea43d Created a changelog
Franz Glasner <hg@dom66.de>
parents:
diff changeset
10
5ca36fbea43d Created a changelog
Franz Glasner <hg@dom66.de>
parents:
diff changeset
11 .. include:: ../CHANGES.txt
5ca36fbea43d Created a changelog
Franz Glasner <hg@dom66.de>
parents:
diff changeset
12
5ca36fbea43d Created a changelog
Franz Glasner <hg@dom66.de>
parents:
diff changeset
13
5ca36fbea43d Created a changelog
Franz Glasner <hg@dom66.de>
parents:
diff changeset
14 .. _api-changes:
5ca36fbea43d Created a changelog
Franz Glasner <hg@dom66.de>
parents:
diff changeset
15
111
d51a18e5b0e3 Reimplement configmix.safe_merge() do to a deepcopy of all source configurations when merging.
Franz Glasner <hg@dom66.de>
parents: 91
diff changeset
16 Breaking Changes
d51a18e5b0e3 Reimplement configmix.safe_merge() do to a deepcopy of all source configurations when merging.
Franz Glasner <hg@dom66.de>
parents: 91
diff changeset
17 ================
d51a18e5b0e3 Reimplement configmix.safe_merge() do to a deepcopy of all source configurations when merging.
Franz Glasner <hg@dom66.de>
parents: 91
diff changeset
18
252
42a6d59cf2ad Put a note about the latest breaking change into the appropriate documentation section also
Franz Glasner <fzglas.hg@dom66.de>
parents: 215
diff changeset
19
42a6d59cf2ad Put a note about the latest breaking change into the appropriate documentation section also
Franz Glasner <fzglas.hg@dom66.de>
parents: 215
diff changeset
20 n/a
42a6d59cf2ad Put a note about the latest breaking change into the appropriate documentation section also
Franz Glasner <fzglas.hg@dom66.de>
parents: 215
diff changeset
21 ---
42a6d59cf2ad Put a note about the latest breaking change into the appropriate documentation section also
Franz Glasner <fzglas.hg@dom66.de>
parents: 215
diff changeset
22
42a6d59cf2ad Put a note about the latest breaking change into the appropriate documentation section also
Franz Glasner <fzglas.hg@dom66.de>
parents: 215
diff changeset
23 - Do not implicitely convert a configuration value to text if the
42a6d59cf2ad Put a note about the latest breaking change into the appropriate documentation section also
Franz Glasner <fzglas.hg@dom66.de>
parents: 215
diff changeset
24 value is the result of just a variable expansion.
42a6d59cf2ad Put a note about the latest breaking change into the appropriate documentation section also
Franz Glasner <fzglas.hg@dom66.de>
parents: 215
diff changeset
25
42a6d59cf2ad Put a note about the latest breaking change into the appropriate documentation section also
Franz Glasner <fzglas.hg@dom66.de>
parents: 215
diff changeset
26 While technically a breaking change no known client is known to rely
42a6d59cf2ad Put a note about the latest breaking change into the appropriate documentation section also
Franz Glasner <fzglas.hg@dom66.de>
parents: 215
diff changeset
27 on the previous behaviour.
42a6d59cf2ad Put a note about the latest breaking change into the appropriate documentation section also
Franz Glasner <fzglas.hg@dom66.de>
parents: 215
diff changeset
28
42a6d59cf2ad Put a note about the latest breaking change into the appropriate documentation section also
Franz Glasner <fzglas.hg@dom66.de>
parents: 215
diff changeset
29
176
24a05dae0e76 FIX: Document the breaking change in the upcoming v0.7 in the chapter for "Breaking Changes" also
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 160
diff changeset
30 0.7
24a05dae0e76 FIX: Document the breaking change in the upcoming v0.7 in the chapter for "Breaking Changes" also
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 160
diff changeset
31 ---
24a05dae0e76 FIX: Document the breaking change in the upcoming v0.7 in the chapter for "Breaking Changes" also
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 160
diff changeset
32
201
24f4ab79a3ab FIX: Docu: "Overhowl" -> "Overhaul".
Franz Glasner <fzglas.hg@dom66.de>
parents: 192
diff changeset
33 - A major overhaul of how filename extensions are associated with loaders
192
46c7d872db83 Changelog: note the latest refactorings
Franz Glasner <fzglas.hg@dom66.de>
parents: 176
diff changeset
34 has been done:
46c7d872db83 Changelog: note the latest refactorings
Franz Glasner <fzglas.hg@dom66.de>
parents: 176
diff changeset
35
46c7d872db83 Changelog: note the latest refactorings
Franz Glasner <fzglas.hg@dom66.de>
parents: 176
diff changeset
36 + Filename extensions in :mod:`fnmatch` style are associated with
205
344da17f01e3 Doc: wording in "Changes"
Franz Glasner <fzglas.hg@dom66.de>
parents: 201
diff changeset
37 file-mode strings.
344da17f01e3 Doc: wording in "Changes"
Franz Glasner <fzglas.hg@dom66.de>
parents: 201
diff changeset
38
344da17f01e3 Doc: wording in "Changes"
Franz Glasner <fzglas.hg@dom66.de>
parents: 201
diff changeset
39 These file-mode strings are associated with loader
344da17f01e3 Doc: wording in "Changes"
Franz Glasner <fzglas.hg@dom66.de>
parents: 201
diff changeset
40 functions separately via the mapping :py:data:`configmix.mode_loaders`.
192
46c7d872db83 Changelog: note the latest refactorings
Franz Glasner <fzglas.hg@dom66.de>
parents: 176
diff changeset
41
46c7d872db83 Changelog: note the latest refactorings
Franz Glasner <fzglas.hg@dom66.de>
parents: 176
diff changeset
42 + :py:func:`configmix.set_assoc`, :py:func:`configmix.get_assoc`,
46c7d872db83 Changelog: note the latest refactorings
Franz Glasner <fzglas.hg@dom66.de>
parents: 176
diff changeset
43 :py:func:`configmix.clear_assoc` and
46c7d872db83 Changelog: note the latest refactorings
Franz Glasner <fzglas.hg@dom66.de>
parents: 176
diff changeset
44 :py:func:`configmix.get_default_assoc` are the new names for the old
46c7d872db83 Changelog: note the latest refactorings
Franz Glasner <fzglas.hg@dom66.de>
parents: 176
diff changeset
45 `set_loader()`, `get_loader()`, `clear_loader()` and
46c7d872db83 Changelog: note the latest refactorings
Franz Glasner <fzglas.hg@dom66.de>
parents: 176
diff changeset
46 `get_default_loader()` functions.
205
344da17f01e3 Doc: wording in "Changes"
Franz Glasner <fzglas.hg@dom66.de>
parents: 201
diff changeset
47 They are used for associating :mod:`fnmatch` style filename patterns
344da17f01e3 Doc: wording in "Changes"
Franz Glasner <fzglas.hg@dom66.de>
parents: 201
diff changeset
48 to file-mode strings. Previously they associated loader functions
344da17f01e3 Doc: wording in "Changes"
Franz Glasner <fzglas.hg@dom66.de>
parents: 201
diff changeset
49 directly.
192
46c7d872db83 Changelog: note the latest refactorings
Franz Glasner <fzglas.hg@dom66.de>
parents: 176
diff changeset
50
46c7d872db83 Changelog: note the latest refactorings
Franz Glasner <fzglas.hg@dom66.de>
parents: 176
diff changeset
51 + :py:func:`configmix.set_assoc` now requires a :mod:`fnmatch` style
46c7d872db83 Changelog: note the latest refactorings
Franz Glasner <fzglas.hg@dom66.de>
parents: 176
diff changeset
52 pattern instead of just a file extension string (i.e. a plain trailer).
46c7d872db83 Changelog: note the latest refactorings
Franz Glasner <fzglas.hg@dom66.de>
parents: 176
diff changeset
53 The previons dictionary with mapping from filename extensions to loader
46c7d872db83 Changelog: note the latest refactorings
Franz Glasner <fzglas.hg@dom66.de>
parents: 176
diff changeset
54 callables is now a list of tuples containing the :mod:`fnmatch` style
46c7d872db83 Changelog: note the latest refactorings
Franz Glasner <fzglas.hg@dom66.de>
parents: 176
diff changeset
55 pattern and the corresponding loader callable.
176
24a05dae0e76 FIX: Document the breaking change in the upcoming v0.7 in the chapter for "Breaking Changes" also
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 160
diff changeset
56
24a05dae0e76 FIX: Document the breaking change in the upcoming v0.7 in the chapter for "Breaking Changes" also
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 160
diff changeset
57
111
d51a18e5b0e3 Reimplement configmix.safe_merge() do to a deepcopy of all source configurations when merging.
Franz Glasner <hg@dom66.de>
parents: 91
diff changeset
58 0.6
d51a18e5b0e3 Reimplement configmix.safe_merge() do to a deepcopy of all source configurations when merging.
Franz Glasner <hg@dom66.de>
parents: 91
diff changeset
59 ---
91
5ca36fbea43d Created a changelog
Franz Glasner <hg@dom66.de>
parents:
diff changeset
60
111
d51a18e5b0e3 Reimplement configmix.safe_merge() do to a deepcopy of all source configurations when merging.
Franz Glasner <hg@dom66.de>
parents: 91
diff changeset
61 - :py:func:`configmix.safe_merge` does now a deepcopy of all source
160
131aaa95d01f FIX: Docu: wording
Franz Glasner <fzglas.hg@dom66.de>
parents: 120
diff changeset
62 configurations when merging. Changes in configuration instances
131aaa95d01f FIX: Docu: wording
Franz Glasner <fzglas.hg@dom66.de>
parents: 120
diff changeset
63 afterwards will not be reflected in the merged configuration any
131aaa95d01f FIX: Docu: wording
Franz Glasner <fzglas.hg@dom66.de>
parents: 120
diff changeset
64 more.
111
d51a18e5b0e3 Reimplement configmix.safe_merge() do to a deepcopy of all source configurations when merging.
Franz Glasner <hg@dom66.de>
parents: 91
diff changeset
65
d51a18e5b0e3 Reimplement configmix.safe_merge() do to a deepcopy of all source configurations when merging.
Franz Glasner <hg@dom66.de>
parents: 91
diff changeset
66 The public signature of :py:func:`configmix.safe_merge` has *not*
d51a18e5b0e3 Reimplement configmix.safe_merge() do to a deepcopy of all source configurations when merging.
Franz Glasner <hg@dom66.de>
parents: 91
diff changeset
67 changed.
120
ba5970a2dcef The default file encoding when reading INI style files with configmix.ini.load() is now "UTF-8".
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 111
diff changeset
68
ba5970a2dcef The default file encoding when reading INI style files with configmix.ini.load() is now "UTF-8".
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 111
diff changeset
69 - The default file encoding when reading INI style files with
ba5970a2dcef The default file encoding when reading INI style files with configmix.ini.load() is now "UTF-8".
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 111
diff changeset
70 :py:func:`configmix.ini.load` is now "UTF-8". Previously it was undefined
ba5970a2dcef The default file encoding when reading INI style files with configmix.ini.load() is now "UTF-8".
Franz Glasner <f.glasner@feldmann-mg.com>
parents: 111
diff changeset
71 and therefore dependent on the user's locale.