pgsql: Fix documentation for libpq's PQfn(). - Mailing list pgsql-committers

From Tom Lane
Subject pgsql: Fix documentation for libpq's PQfn().
Date
Msg-id E1YUf7a-0007cb-8g@gemulon.postgresql.org
Whole thread Raw
List 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
------
master

Details
-------
http://git.postgresql.org/pg/commitdiff/1a0bc4c2bfc278b63965486b1525ad04a1f85989

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


pgsql-committers by date:

Previous
From: Tom Lane
Date:
Subject: pgsql: Code cleanup for REINDEX DATABASE/SCHEMA/SYSTEM.
Next
From: Tom Lane
Date:
Subject: pgsql: Fix documentation for libpq's PQfn().