doc: correct description of libpq's PQsetnonblocking() mode
authorBruce Momjian <[email protected]>
Mon, 13 Nov 2023 19:03:36 +0000 (14:03 -0500)
committerBruce Momjian <[email protected]>
Mon, 13 Nov 2023 19:03:36 +0000 (14:03 -0500)
Reported-by: Yugo NAGATA
Discussion: https://postgr.es/m/20210713115949.702986955f8ccf23fa81073c@sraoss.co.jp

Backpatch-through: 12-16, master already done

doc/src/sgml/libpq.sgml

index 1788bb06e033ea22fe625edf9521a8740c036e57..7f34755cd5d8e87e6236e6220e71e070a76d914d 100644 (file)
@@ -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>