doc: correct description of libpq's PQsetnonblocking() mode
authorBruce Momjian <bruce@momjian.us>
Mon, 13 Nov 2023 19:03:37 +0000 (14:03 -0500)
committerBruce Momjian <bruce@momjian.us>
Mon, 13 Nov 2023 19:03:37 +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 72150c57cc0f699e984776033163ad0a25f7df2f..584a6dadb74ac0c5a18d7fcbc3746ceb126f399e 100644 (file)
@@ -4790,11 +4790,12 @@ int PQsetnonblocking(PGconn *conn, int arg);
       </para>
 
       <para>
-       In the nonblocking state, calls to
+       In the nonblocking state, successful calls to
        <xref linkend="libpq-PQsendQuery"/>, <xref linkend="libpq-PQputline"/>,
        <xref linkend="libpq-PQputnbytes"/>, <xref linkend="libpq-PQputCopyData"/>,
-       and <xref linkend="libpq-PQendcopy"/> will not block but instead return
-       an error if they need to be called again.
+       and <xref linkend="libpq-PQendcopy"/> 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>