summaryrefslogtreecommitdiffhomepage
path: root/sites/www
diff options
context:
space:
mode:
authorJeff Forcier <jeff@bitprophet.org>2014-04-24 09:33:38 -0700
committerJeff Forcier <jeff@bitprophet.org>2014-04-24 09:33:38 -0700
commit5636381591aa26a9f31efab450b6bfdd6659cbb3 (patch)
treea81299cb4356a54653c3f71d758537c284d09232 /sites/www
parent3fce8abf68f386d18f2fad9f086e0d436af57b3a (diff)
Reword docs/changelog re #315
Diffstat (limited to 'sites/www')
-rw-r--r--sites/www/changelog.rst20
1 files changed, 13 insertions, 7 deletions
diff --git a/sites/www/changelog.rst b/sites/www/changelog.rst
index 67c4f827..8a4b0f56 100644
--- a/sites/www/changelog.rst
+++ b/sites/www/changelog.rst
@@ -2,13 +2,19 @@
Changelog
=========
-* :bug: BufferedFile.read() now returns byte strings instead of text strings
- It is the right thing to do since we have no idea what encoding the file
- is in, or even if the file is text data. BufferedFile.readline() is
- unchanged and returns text strings assuming the file is utf-8 encoded.
- This should fix the following issue:
- http://comments.gmane.org/gmane.comp.sysutils.backup.obnam/252
- Thanks Antoine Brenner
+* :bug:`-` `paramiko.file.BufferedFile.read` incorrectly returned text strings
+ after the Python 3 migration, despite bytes being more appropriate for file
+ contents (which may be binary or of an unknown encoding.) This has been
+ addressed.
+
+ .. note::
+ `paramiko.file.BufferedFile.readline` continues to return strings, not
+ bytes, as "lines" only make sense for textual data. It assumes UTF-8 by
+ default.
+
+ This should fix `this issue raised on the Obnam mailing list
+ <http://comments.gmane.org/gmane.comp.sysutils.backup.obnam/252>`_. Thanks
+ to Antoine Brenner for the patch.
* :bug:`-` Added self.args for exception classes. Used for unpickling. Related
to (`Fabric #986 <https://github.com/fabric/fabric/issues/986>`_, `Fabric
#714 <https://github.com/fabric/fabric/issues/714>`_). Thanks to Alex