diff --git a/docs/development.rst b/docs/development.rst index 8fa3ba205..50e4f0592 100644 --- a/docs/development.rst +++ b/docs/development.rst @@ -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 ---------------------- diff --git a/src/borg/item.py b/src/borg/item.py index 84d5085ec..e44e4367b 100644 --- a/src/borg/item.py +++ b/src/borg/item.py @@ -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. """