pgsql: Remove dead code in ECPGconnect(), and improve documentation.

From: Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>
To: pgsql-committers(at)lists(dot)postgresql(dot)org
Subject: pgsql: Remove dead code in ECPGconnect(), and improve documentation.
Date: 2021-02-11 20:06:03
Message-ID: E1lAIDz-0003EC-R6@gemulon.postgresql.org
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-committers

Remove dead code in ECPGconnect(), and improve documentation.

The stanza in ECPGconnect() that intended to allow specification of a
Unix socket directory path in place of a port has never executed since
it was committed, nearly two decades ago; the preceding strrchr()
already found the last colon so there cannot be another one. The lack
of complaints about that is doubtless related to the fact that no
user-facing documentation suggested it was possible.

Rather than try to fix that up, let's just remove the unreachable
code, and instead document the way that does work to write a socket
directory path, namely specifying it as a "host" option.

In support of that, make another pass at clarifying the syntax
documentation for ECPG connection targets, particularly documenting
which things are parsed as identifiers and where to use double quotes.
Rearrange some things that seemed poorly ordered, and fix a couple of
minor doc errors.

Kyotaro Horiguchi, per gripe from Shenhao Wang
(docs changes mostly by me)

Discussion: https://postgr.es/m/ae52a416bbbf459c96bab30b3038e06c@G08CNEXMBPEKD06.g08.fujitsu.local

Branch
------
master

Details
-------
https://git.postgresql.org/pg/commitdiff/62535cae9723afc48173ba1be65f1c7491813fc2

Modified Files
--------------
doc/src/sgml/ecpg.sgml | 64 ++++++++++++++++++++++-------------
src/interfaces/ecpg/ecpglib/connect.c | 48 ++++++--------------------
2 files changed, 52 insertions(+), 60 deletions(-)

Browse pgsql-committers by date

  From Date Subject
Next Message Peter Geoghegan 2021-02-11 20:53:30 Re: pgsql: Add functions to 'pageinspect' to inspect GiST indexes.
Previous Message Tom Lane 2021-02-11 18:46:07 Re: Detecting pointer misalignment (was Re: pgsql: Implementation of subscripting for jsonb)