aboutsummaryrefslogtreecommitdiff
path: root/doc/src
diff options
context:
space:
mode:
authorRobert Haas <rhaas@postgresql.org>2012-03-22 22:09:20 -0400
committerRobert Haas <rhaas@postgresql.org>2012-03-22 22:09:20 -0400
commite08b4101e1daa2f4e6644330918177a10cac0aab (patch)
treebcdd2d4a7e1ef5e3f323191016d6edaec9c2b1f0 /doc/src
parentfdf719cd2868144b5bd78971217bb36bb970e15e (diff)
downloadpostgresql-e08b4101e1daa2f4e6644330918177a10cac0aab.tar.gz
postgresql-e08b4101e1daa2f4e6644330918177a10cac0aab.zip
Clarify that PQconninfoParse returns an array with all legal options.
Per discussion with Dmitriy Igrishin and Tom Lane.
Diffstat (limited to 'doc/src')
-rw-r--r--doc/src/sgml/libpq.sgml6
1 files changed, 4 insertions, 2 deletions
diff --git a/doc/src/sgml/libpq.sgml b/doc/src/sgml/libpq.sgml
index 72c93845beb..96064bbb0de 100644
--- a/doc/src/sgml/libpq.sgml
+++ b/doc/src/sgml/libpq.sgml
@@ -1027,8 +1027,10 @@ PQconninfoOption *PQconninfoParse(const char *conninfo, char **errmsg);
</para>
<para>
- Note that only options explicitly specified in the string will have
- values set in the result array; no defaults are inserted.
+ All legal options will be present in the result array, but the
+ <literal>PQconninfoOption</literal> for any option not present
+ in the connection string will have <literal>val</literal> set to
+ <literal>NULL</literal>; default values are not inserted.
</para>
<para>