From: Bruce Momjian <bruce@momjian.us>
Date: Tue, 20 Feb 2007 19:59:18 +0000 (+0000)
Subject: Update "encode" documentation to mention that 'escape' only changes null
X-Git-Tag: REL8_2_4~43
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=664009ecb16039244f77d3f1e6c87c521562ccda;p=postgresql

Update "encode" documentation to mention that 'escape' only changes null
bytes and backslashes, remove "ASCII" mention.  Backpatch to 8.2.X.
---

diff --git a/doc/src/sgml/func.sgml b/doc/src/sgml/func.sgml
index 431e0c10fa..d717946503 100644
--- a/doc/src/sgml/func.sgml
+++ b/doc/src/sgml/func.sgml
@@ -1,4 +1,4 @@
-<!-- $PostgreSQL: pgsql/doc/src/sgml/func.sgml,v 1.347.2.5 2007/02/20 14:05:02 momjian Exp $ -->
+<!-- $PostgreSQL: pgsql/doc/src/sgml/func.sgml,v 1.347.2.6 2007/02/20 19:59:18 momjian Exp $ -->
 
  <chapter id="functions">
   <title>Functions and Operators</title>
@@ -1326,8 +1326,10 @@
        </entry>
        <entry><type>text</type></entry>
        <entry>
-        Encode binary data to <acronym>ASCII</acronym>-only representation.  Supported
+        Encode binary data to different representation.  Supported
         types are: <literal>base64</>, <literal>hex</>, <literal>escape</>.
+        <literal>Escape</> merely outputs null bytes as <literal>\000</> and
+        doubles backslashes.
        </entry>
        <entry><literal>encode( E'123\\000\\001', 'base64')</literal></entry>
        <entry><literal>MTIzAAE=</literal></entry>