[Python-checkins] CVS: python/dist/src/Doc/lib libpickle.tex,1.30,1.31

[Barry Warsaw]

Update of /cvsroot/python/python/dist/src/Doc/lib
In directory usw-pr-cvs1:/tmp/cvs-serv11321/Doc/lib

Modified Files:
	libpickle.tex 
Log Message:
A massive rewrite affecting both the pickle and cPickle module
documentation.  This addresses previously undocumented parts of the
public interfaces, the differences between pickle and cPickle,
security concerns, and on and on.

Fred please proofread!


Index: libpickle.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libpickle.tex,v
retrieving revision 1.30
retrieving revision 1.31
diff -C2 -d -r1.30 -r1.31
*** libpickle.tex	2001/10/20 04:24:09	1.30
--- libpickle.tex	2001/11/15 23:39:07	1.31
***************
*** 1,8 ****
! \section{\module{pickle} ---
!          Python object serialization}
  
  \declaremodule{standard}{pickle}
  \modulesynopsis{Convert Python objects to streams of bytes and back.}
  % Substantial improvements by Jim Kerr <jbkerr@sr.hp.com>.
  
  \index{persistence}
--- 1,8 ----
! \section{\module{pickle} --- Python object serialization}
[...989 lines suppressed...]
! should benefit from the greatly improved performance of the
! \module{cPickle} module.
  
! The pickle data stream produced by \module{pickle} and
! \module{cPickle} are identical, so it is possible to use
! \module{pickle} and \module{cPickle} interchangeably with existing
! pickles\footnote{Since the pickle data format is actually a tiny
! stack-oriented programming language, and some freedom is taken in the
! encodings of certain objects, it is possible that the two modules
! produce different data streams for the same input objects.  However it
! is guaranteed that they will always be able to read each other's
! data streams.}.
  
! There are additional minor differences in API between \module{cPickle}
! and \module{pickle}, however for most applications, they are
! interchangable.  More documentation is provided in the
! \module{pickle} module documentation, which
! includes a list of the documented differences.
! 
!