Remove dead code in ECPGconnect(), and improve documentation.
authorTom Lane <tgl@sss.pgh.pa.us>
Thu, 11 Feb 2021 20:05:55 +0000 (15:05 -0500)
committerTom Lane <tgl@sss.pgh.pa.us>
Thu, 11 Feb 2021 20:05:55 +0000 (15:05 -0500)
commit62535cae9723afc48173ba1be65f1c7491813fc2
tree44ad4a90eb6e9cb36ba56330b8ffddb2de681f8d
parent69036aafb9a8f425fb489125b5075ba7719d20d0
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
doc/src/sgml/ecpg.sgml
src/interfaces/ecpg/ecpglib/connect.c