Doc: remove misleading claim in documentation of PQreset().
authorTom Lane <[email protected]>
Fri, 22 Jan 2021 16:29:43 +0000 (11:29 -0500)
committerTom Lane <[email protected]>
Fri, 22 Jan 2021 16:29:43 +0000 (11:29 -0500)
This text claimed that the reconnection would occur "to the same
server", but there is no such guarantee in the code, nor would
insisting on that be an improvement.

Back-patch to v10 where multi-host connection strings were added.

Discussion: https://postgr.es/m/1095901.1611268376@sss.pgh.pa.us

doc/src/sgml/libpq.sgml

index 2bb3bf77e432d5cf5add5ed8d37e8ea5674587d0..b22cb38ca3b295a3a1ea36a6f923ef10fad0a78e 100644 (file)
@@ -645,8 +645,8 @@ void PQreset(PGconn *conn);
 
       <para>
        This function will close the connection
-       to the server and attempt to  reestablish  a  new
-       connection to the same server, using all the same
+       to the server and attempt to establish a new
+       connection, using all the same
        parameters previously used.  This might be useful for
        error recovery if a working connection is lost.
       </para>
@@ -669,7 +669,7 @@ PostgresPollingStatusType PQresetPoll(PGconn *conn);
 
       <para>
        These functions will close the connection to the server and attempt to
-       reestablish a new connection to the same server, using all the same
+       establish a new connection, using all the same
        parameters previously used. This can be useful for error recovery if a
        working connection is lost. They differ from <xref linkend="libpq-PQreset"/> (above) in that they
        act in a nonblocking manner. These functions suffer from the same