Document encode(bytea, 'escape')'s behavior correctly.
authorTom Lane
Fri, 29 Mar 2013 03:14:58 +0000 (23:14 -0400)
committerTom Lane
Fri, 29 Mar 2013 03:14:58 +0000 (23:14 -0400)
I changed this in commit fd15dba543247eb1ce879d22632b9fdb4c230831, but
missed the fact that the SGML documentation of the function specified
exactly what it did.  Well, one of the two places where it's specified
documented that --- probably I looked at the other place and thought
nothing needed to be done.  Sync the two places where encode() and
decode() are described.

doc/src/sgml/func.sgml

index 7d39b272f06867a339524bf11403fe7b55d0b98a..4309cbf520d605ef2a246bc6dba808180405ebcb 100644 (file)
        
         Encode binary data into a textual representation.  Supported
         formats are: base64, hex, escape.
-        escape merely outputs null bytes as \000 and
+        escape converts zero bytes and high-bit-set bytes to
+        octal sequences (\nnn) and
         doubles backslashes.
        
        encode(E'123\\000\\001', 'base64')
          decode
         
        decode(string text,
-              type text)
+       format text)
       
       bytea
       
-       Decode binary string from string previously
-       encoded with encode.  Parameter type is same as in encode.
+       Decode binary data from textual representation in string.
+       Options for format are same as in encode.
       
       decode(E'123\\000456', 'escape')
       123\000456
         
          encode
         
-       encode(string bytea,
-              type text)
+       encode(data bytea,
+       format text)
       
       text
       
-       Encode binary string to ASCII-only representation.  Supported
-       types are: base64, hex, escape.
+       Encode binary data into a textual representation.  Supported
+       formats are: base64, hex, escape.
+       escape converts zero bytes and high-bit-set bytes to
+       octal sequences (\nnn) and
+       doubles backslashes.
       
       encode(E'123\\000456'::bytea, 'escape')
       123\000456