[Bug #486527] Note that the caller has to ensure there are no control

akuchling · akuchling · commit 10b3eac278b4 · 2002-03-08T17:46:02.000Z
characters in strings being passed via XML-RPC.
Fix some typos.

2.2.1 bugfix candidate.
diff --git a/Doc/lib/libxmlrpclib.tex b/Doc/lib/libxmlrpclib.tex
@@ -59,6 +59,16 @@ \section{\module{xmlrpclib} --- XML-RPC client access}
 may also raise a special \exception{Fault} instance, used to signal
 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}
 
 
@@ -200,15 +210,15 @@ \subsection{ProtocolError Objects \label{protocol-error-objects}}
 members:
 
 \begin{memberdesc}{url}
-The URI or URL that triggered te error.
+The URI or URL that triggered the error.
 \end{memberdesc}
 
 \begin{memberdesc}{errcode}
 The error code.
 \end{memberdesc}
 
 \begin{memberdesc}{errmsg}
-The eror message of diagnostic string.
+The error message or diagnostic string.
 \end{memberdesc}
 
 \begin{memberdesc}{headers}
