Doc: Improve description of connection strings with Percent-encoding

michaelpq · michaelpq · commit e0ed6817c0ee · 2020-01-19T18:55:51.000+09:00
Clarify the description related to the use of characters which can be encoded, and add an example. Author: Jobin Augustine Reviewed-by: Peter Eisentraut, Alvaro Herrera, Heikki Linnakangas, Michael Paquier, Alex Shulgin Discussion: https://postgr.es/m/CANaTPsrYgSgE2fuj3=4x=Jmx1c+NgkEDzftNknZbrMuqL+aBhQ@mail.gmail.com
diff --git a/doc/src/sgml/libpq.sgml b/doc/src/sgml/libpq.sgml
@@ -925,10 +925,15 @@ postgresql://github.com/mydb?host=localhost&amp;port=5433
    </para>
 
    <para>
-    Percent-encoding may be used to include symbols with special meaning in any
-    of the <acronym>URI</acronym> parts, e.g. replace <literal>=</literal> with
-    <literal>%3D</literal>.
-
+    Connection <acronym>URI</acronym> needs to be encoded with 
+    <ulink url="https://tools.ietf.org/html/rfc3986#section-2.1">Percent-encoding</ulink> 
+    if it includes symbols with special meaning in any of its parts. 
+    Here is an example where equal sign (<literal>=</literal>) is replaced
+    with <literal>%3D</literal> and whitespace character with
+    <literal>%20</literal>:
+<programlisting>
+postgresql://user@localhost:5433/mydb?options=-c%20synchronous_commit%3Doff
+</programlisting>
    </para>
 
    <para>
