From: Georg Brandl <georg@python.org>
Date: Mon, 20 Feb 2006 13:12:02 +0000 (+0000)
Subject: Bug #1102649: add a note to pickle docs that pickle files should be
X-Git-Tag: v2.5a0~572
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=69774c212a35c5b271729a47dc9ae2fc6d7cef29;p=thirdparty%2FPython%2Fcpython.git

Bug #1102649: add a note to pickle docs that pickle files should be
opened in binary mode.
---

diff --git a/Doc/lib/libpickle.tex b/Doc/lib/libpickle.tex
index 99dd330e6324..45e80b82ccb3 100644
--- a/Doc/lib/libpickle.tex
+++ b/Doc/lib/libpickle.tex
@@ -163,8 +163,17 @@ as a \var{protocol} value.
 \versionadded{2.3}
 \end{datadesc}
 
+\note{Be sure to always open pickle files created with protocols >= 1 in
+      binary mode. For the old ASCII-based pickle protocol 0 you can use
+      either text mode or binary mode as long as you stay consistent.
+      
+      A pickle file written with protocol 0 in binary mode will contain
+      lone linefeeds as line terminators and therefore will look ``funny''
+      when viewed in Notepad or other editors which do not support this
+      format.}
+
 The \module{pickle} module provides the
-following functions to make this process more convenient:
+following functions to make the pickling process more convenient:
 
 \begin{funcdesc}{dump}{obj, file\optional{, protocol}}
 Write a pickled representation of \var{obj} to the open file object