pgsql: Fix documentation for libpq's PQfn().

From: Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>
To: pgsql-committers(at)postgresql(dot)org
Subject: pgsql: Fix documentation for libpq's PQfn().
Date: 2015-03-08 17:36:10
Message-ID: E1YUf7a-0007cn-9Z@gemulon.postgresql.org
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-committers

Fix documentation for libpq's PQfn().

The SGML docs claimed that 1-byte integers could be sent or received with
the "isint" options, but no such behavior has ever been implemented in
pqGetInt() or pqPutInt(). The in-code documentation header for PQfn() was
even less in tune with reality, and the code itself used parameter names
matching neither the SGML docs nor its libpq-fe.h declaration. Do a bit
of additional wordsmithing on the SGML docs while at it.

Since the business about 1-byte integers is a clear documentation bug,
back-patch to all supported branches.

Branch
------
REL9_0_STABLE

Details
-------
http://git.postgresql.org/pg/commitdiff/a07bd32f2b130a67bf285f8ef5f1fe4ebcc3a5b8

Modified Files
--------------
doc/src/sgml/libpq.sgml | 23 +++++++++++++++--------
src/interfaces/libpq/fe-exec.c | 22 ++++++++++------------
2 files changed, 25 insertions(+), 20 deletions(-)

Browse pgsql-committers by date

  From Date Subject
Next Message Tom Lane 2015-03-08 17:43:03 pgsql: Remove struct PQArgBlock from server-side header libpq/libpq.h.
Previous Message Tom Lane 2015-03-08 16:18:50 pgsql: Code cleanup for REINDEX DATABASE/SCHEMA/SYSTEM.