Document maintenance merge command

This commit is contained in:
Marian Beermann 2016-11-13 16:07:01 +01:00
parent 0d2b76fa7d
commit c2eb2539b9
No known key found for this signature in database
GPG Key ID: 9B8450B91D1362C1
2 changed files with 11 additions and 1 deletions

View File

@ -214,6 +214,16 @@ If you encounter issues, see also our `Vagrantfile` for details.
without external dependencies.
Merging maintenance branches
----------------------------
As mentioned above bug fixes will usually be merged into a maintenance branch (x.y-maint) and then
merged back into the master branch. Large diffs between these branches can make automatic merges troublesome,
therefore we recommend to use these merge parameters::
git merge 1.0-maint -s recursive -X rename-threshold=20%
Creating a new release
----------------------

View File

@ -20,7 +20,7 @@ class PropDict:
When "packing" a dict, ie. you have a dict with some data and want to convert it into an instance,
then use eg. Item({'a': 1, ...}). This way all keys in your dictionary are validated.
When "unpacking", that is you've read a dictionary with some data from somewhere (eg mspack),
When "unpacking", that is you've read a dictionary with some data from somewhere (eg. msgpack),
then use eg. Item(internal_dict={...}). This does not validate the keys, therefore unknown keys
are ignored instead of causing an error.
"""