Skip to content

Commit 83eb244

Browse files
committed
Fix a typo and some doc indentation related to libpq pipeline functions
Noticed while reviewing the area for a different patch. This is cosmetic, so no backpatch is done.
1 parent 237d011 commit 83eb244

File tree

2 files changed

+19
-19
lines changed

2 files changed

+19
-19
lines changed

doc/src/sgml/libpq.sgml

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -5813,28 +5813,28 @@ int PQpipelineSync(PGconn *conn);
58135813
<varlistentry id="libpq-PQsendFlushRequest">
58145814
<term><function>PQsendFlushRequest</function><indexterm><primary>PQsendFlushRequest</primary></indexterm></term>
58155815

5816-
<listitem>
5817-
<para>
5818-
Sends a request for the server to flush its output buffer.
5816+
<listitem>
5817+
<para>
5818+
Sends a request for the server to flush its output buffer.
58195819
<synopsis>
58205820
int PQsendFlushRequest(PGconn *conn);
58215821
</synopsis>
5822-
</para>
5822+
</para>
58235823

5824-
<para>
5825-
Returns 1 for success. Returns 0 on any failure.
5826-
</para>
5827-
<para>
5828-
The server flushes its output buffer automatically as a result of
5829-
<function>PQpipelineSync</function> being called, or
5830-
on any request when not in pipeline mode; this function is useful
5831-
to cause the server to flush its output buffer in pipeline mode
5832-
without establishing a synchronization point.
5833-
Note that the request is not itself flushed to the server automatically;
5834-
use <function>PQflush</function> if necessary.
5835-
</para>
5836-
</listitem>
5837-
</varlistentry>
5824+
<para>
5825+
Returns 1 for success. Returns 0 on any failure.
5826+
</para>
5827+
<para>
5828+
The server flushes its output buffer automatically as a result of
5829+
<function>PQpipelineSync</function> being called, or
5830+
on any request when not in pipeline mode; this function is useful
5831+
to cause the server to flush its output buffer in pipeline mode
5832+
without establishing a synchronization point.
5833+
Note that the request is not itself flushed to the server automatically;
5834+
use <function>PQflush</function> if necessary.
5835+
</para>
5836+
</listitem>
5837+
</varlistentry>
58385838
</variablelist>
58395839
</sect2>
58405840

src/interfaces/libpq/fe-exec.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3235,7 +3235,7 @@ pqPipelineProcessQueue(PGconn *conn)
32353235
* error, a PGresult with PGRES_PIPELINE_SYNC is produced.
32363236
*
32373237
* Queries can already have been sent before PQpipelineSync is called, but
3238-
* PQpipelineSync need to be called before retrieving command results.
3238+
* PQpipelineSync needs to be called before retrieving command results.
32393239
*
32403240
* The connection will remain in pipeline mode and unavailable for new
32413241
* synchronous command execution functions until all results from the pipeline

0 commit comments

Comments
 (0)