From: Bruce Momjian <bruce@momjian.us>
Date: Mon, 13 Nov 2023 19:03:36 +0000 (-0500)
Subject: doc:  correct description of libpq's PQsetnonblocking() mode
X-Git-Tag: REL_12_18~74
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=b64926fbfda6efc0ea51d91a2dabe73abb4a683d;p=thirdparty%2Fpostgresql.git

doc:  correct description of libpq's PQsetnonblocking() mode

Reported-by: Yugo NAGATA

Discussion: https://postgr.es/m/20210713115949.702986955f8ccf23fa81073c@sraoss.co.jp

Backpatch-through: 12-16, master already done
---

diff --git a/doc/src/sgml/libpq.sgml b/doc/src/sgml/libpq.sgml
index 1788bb06e03..7f34755cd5d 100644
--- a/doc/src/sgml/libpq.sgml
+++ b/doc/src/sgml/libpq.sgml
@@ -4941,11 +4941,12 @@ int PQsetnonblocking(PGconn *conn, int arg);
       </para>
 
       <para>
-       In the nonblocking state, calls to
+       In the nonblocking state, successful calls to
        <function>PQsendQuery</function>, <function>PQputline</function>,
        <function>PQputnbytes</function>, <function>PQputCopyData</function>,
-       and <function>PQendcopy</function> will not block but instead return
-       an error if they need to be called again.
+       and <function>PQendcopy</function> will not block;  their changes
+       are stored in the local output buffer until they are flushed.
+       Unsuccessful calls will return an error and must be retried.
       </para>
 
       <para>