From 40ed59b2867fff9b1b4470e430c2d66732a05c2c Mon Sep 17 00:00:00 2001
From: Robert Haas <rhaas@postgresql.org>
Date: Wed, 23 Jan 2013 11:05:15 -0500
Subject: [PATCH] Clarify that connection parameters aren't totally meaningless
for PQping.
Per discussion with Phil Sorber.
---
doc/src/sgml/libpq.sgml | 10 ++++++----
1 file changed, 6 insertions(+), 4 deletions(-)
diff --git a/doc/src/sgml/libpq.sgml b/doc/src/sgml/libpq.sgml
index d03ec40e333..e36dd4b1d12 100644
--- a/doc/src/sgml/libpq.sgml
+++ b/doc/src/sgml/libpq.sgml
@@ -648,9 +648,10 @@ PostgresPollingStatusType PQresetPoll(PGconn *conn);
<para>
<function>PQpingParams</function> reports the status of the
server. It accepts connection parameters identical to those of
- <function>PQconnectdbParams</>, described above. It is not, however,
+ <function>PQconnectdbParams</>, described above. It is not
necessary to supply correct user name, password, or database name
- values to obtain the server status.
+ values to obtain the server status; however, if incorrect values
+ are provided, the server will log a failed connection attempt.
<synopsis>
PGPing PQpingParams(const char * const *keywords,
@@ -716,9 +717,10 @@ PGPing PQpingParams(const char * const *keywords,
<para>
<function>PQping</function> reports the status of the
server. It accepts connection parameters identical to those of
- <function>PQconnectdb</>, described above. It is not, however,
+ <function>PQconnectdb</>, described above. It is not
necessary to supply correct user name, password, or database name
- values to obtain the server status.
+ values to obtain the server status; however, if incorrect values
+ are provided, the server will log a failed connection attempt.
<synopsis>
PGPing PQping(const char *conninfo);
--
GitLab