Re: Add clarification example to EXEC SQL CONNECT with password - Mailing list pgsql-docs

From Bruce Momjian
Subject Re: Add clarification example to EXEC SQL CONNECT with password
Date
Msg-id 20130125172959.GB6848@momjian.us
Whole thread Raw
In response to Re: Add clarification example to EXEC SQL CONNECT with password  (Tom Lane <tgl@sss.pgh.pa.us>)
Responses Re: Add clarification example to EXEC SQL CONNECT with password  (Tom Lane <tgl@sss.pgh.pa.us>)
List pgsql-docs
On Fri, Jan 25, 2013 at 12:25:32PM -0500, Tom Lane wrote:
> Bruce Momjian <bruce@momjian.us> writes:
> > *** a/doc/src/sgml/ecpg.sgml
> > --- b/doc/src/sgml/ecpg.sgml
> > *************** EXEC SQL CONNECT TO unix:postgresql://sq
> > *** 194,202 ****
> >   EXEC SQL BEGIN DECLARE SECTION;
> >   const char *target = "mydb@sql.mydomain.com";
> >   const char *user = "john";
> >   EXEC SQL END DECLARE SECTION;
> >    ...
> > ! EXEC SQL CONNECT TO :target USER :user;
> >   </programlisting>
> >      The last form makes use of the variant referred to above as
> >      character variable reference.  You will see in later sections how C
> > --- 194,205 ----
> >   EXEC SQL BEGIN DECLARE SECTION;
> >   const char *target = "mydb@sql.mydomain.com";
> >   const char *user = "john";
> > + const char *passwd = "secret";
> >   EXEC SQL END DECLARE SECTION;
> >    ...
> > ! EXEC SQL CONNECT TO :target USER :user USING :passwd;
> > !
> > ! EXEC SQL CONNECT TO :target USER :user/:passwd;
> >   </programlisting>
> >      The last form makes use of the variant referred to above as
> >      character variable reference.  You will see in later sections how C
>
> This sure looks like it has broken the intention of the paragraph
> immediately after the example.  Also, it seems like you are providing
> two alternative ways of doing the same thing, but not explaining that.
> How is a reader supposed to know that he doesn't have to do both
> commands?

Yeah, I was worried about that, so I added the blank line.  If you look
at the docs, we already are providing three connection examples, so now
there are four.  You can see the current docs here (the official ones
are not updated yet):

    http://momjian.us/pgsql_docs/ecpg-connect.html#ECPG-CONNECTING

I am open to suggestions.

--
  Bruce Momjian  <bruce@momjian.us>        http://momjian.us
  EnterpriseDB                             http://enterprisedb.com

  + It's impossible for everything to be true. +


pgsql-docs by date:

Previous
From: Tom Lane
Date:
Subject: Re: Add clarification example to EXEC SQL CONNECT with password
Next
From: Tom Lane
Date:
Subject: Re: Add clarification example to EXEC SQL CONNECT with password