[Python-checkins] CVS: python/dist/src/Doc/lib libxmlrpclib.tex,1.5,1.5.10.1

Michael Hudson mwh@users.sourceforge.net
Mon, 11 Mar 2002 02:05:09 -0800


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

Modified Files:
      Tag: release22-maint
	libxmlrpclib.tex 
Log Message:
backport akuchling's checkin of
    revision 1.6 of libxmlrpclib.tex

[Bug #486527] Note that the caller has to ensure there are no control
    characters in strings being passed via XML-RPC.
Fix some typos.

2.2.1 bugfix candidate.


Index: libxmlrpclib.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libxmlrpclib.tex,v
retrieving revision 1.5
retrieving revision 1.5.10.1
diff -C2 -d -r1.5 -r1.5.10.1
*** libxmlrpclib.tex	1 Oct 2001 21:05:30 -0000	1.5
--- libxmlrpclib.tex	11 Mar 2002 10:05:07 -0000	1.5.10.1
***************
*** 60,63 ****
--- 60,73 ----
  XML-RPC server errors, or \exception{ProtocolError} used to signal an
  error in the HTTP/HTTPS transport layer.
+ 
+ When passing strings, characters special to XML such as \samp{<},
+ \samp{>}, and \samp{\&} will be automatically escaped.  However, it's
+ the caller's responsibility to ensure that the string is free of
+ characters that aren't allowed in XML, such as the control characters
+ with ASCII values between 0 and 31; failing to do this will result in
+ an XML-RPC request that isn't well-formed XML.  If you have to pass
+ arbitrary strings via XML-RPC, use the \class{Binary} wrapper class
+ described below.
+ 
  \end{classdesc}
  
***************
*** 201,205 ****
  
  \begin{memberdesc}{url}
! The URI or URL that triggered te error.
  \end{memberdesc}
  
--- 211,215 ----
  
  \begin{memberdesc}{url}
! The URI or URL that triggered the error.
  \end{memberdesc}
  
***************
*** 209,213 ****
  
  \begin{memberdesc}{errmsg}
! The eror message of diagnostic string.
  \end{memberdesc}
  
--- 219,223 ----
  
  \begin{memberdesc}{errmsg}
! The error message or diagnostic string.
  \end{memberdesc}