Doucumentation bug in libpq > Asynchronous Query Processing

Started by PostgreSQL Bugs Listabout 25 years ago2 messagesbugs
Jump to latest
#1PostgreSQL Bugs List
pgsql-bugs@postgresql.org

Philip (philip.howell@cit.act.edu.au) reports a bug with a severity of 3
The lower the number the more severe it is.

Short Description
Doucumentation bug in libpq > Asynchronous Query Processing

Long Description
In the online docs:

http://postgresql.org/users-lounge/docs/7.0/postgres/libpq-chapter22577.htm

there is a problem with documentation regarding the function PQsetnonblocking. The documentation defines the function as:

int PQsetnonblocking(PGconn *conn)

While in libpq-fe.h (installed from rpm postgresql-devel-7.0.3-2) it is defined as:

int PQsetnonblocking(PGconn *conn, int arg)

Which has an extra argument arg. I guessed that this argument was to be TRUE or FALSE, to set or unset blocking, and this seems to work, however there is no mention of the argument in the docs.

Regards

Phil

Sample Code

No file was uploaded with this report

#2Bruce Momjian
bruce@momjian.us
In reply to: PostgreSQL Bugs List (#1)
Re: Doucumentation bug in libpq > Asynchronous Query Processing

This is fixed in the current docs:

#$ grep PQsetnonblocking *.sgml
libpq.sgml: <function>PQsetnonblocking</function> had been called.
libpq.sgml:address that issue, the function
<function>PQsetnonblocking</function>
libpq.sgml:Old applications can neglect to use
<function>PQsetnonblocking</function>
libpq.sgml:<function>PQsetnonblocking</function> to achieve a completely
non-blocking
libpq.sgml: <function>PQsetnonblocking</function> Sets the
nonblocking status of the
libpq.sgml:int PQsetnonblocking(PGconn *conn, int arg)
libpq.sgml: <function>PQsetnonblocking</function> functionality in
the near future.
libpq.sgml:<function>PQsetnonblocking</function> have a need for this.
libpq.sgml:Non-blocking connections (that have used
<function>PQsetnonblocking</function>)

Philip (philip.howell@cit.act.edu.au) reports a bug with a severity of 3
The lower the number the more severe it is.

Short Description
Doucumentation bug in libpq > Asynchronous Query Processing

Long Description
In the online docs:

http://postgresql.org/users-lounge/docs/7.0/postgres/libpq-chapter22577.htm

there is a problem with documentation regarding the function PQsetnonblocking. The documentation defines the function as:

int PQsetnonblocking(PGconn *conn)

While in libpq-fe.h (installed from rpm postgresql-devel-7.0.3-2) it is defined as:

int PQsetnonblocking(PGconn *conn, int arg)

Which has an extra argument arg. I guessed that this argument was to be TRUE or FALSE, to set or unset blocking, and this seems to work, however there is no mention of the argument in the docs.

Regards

Phil

Sample Code

No file was uploaded with this report

---------------------------(end of broadcast)---------------------------
TIP 1: subscribe and unsubscribe commands go to majordomo@postgresql.org

-- 
  Bruce Momjian                        |  http://candle.pha.pa.us
  pgman@candle.pha.pa.us               |  (610) 853-3000
  +  If your life is a hard drive,     |  830 Blythe Avenue
  +  Christ can be your backup.        |  Drexel Hill, Pennsylvania 19026