Date: Thu, 31 Jan 2008 12:27:36 -0300
From: Alvaro Herrera <alvherre@commandprompt.com>
To: Bruce Momjian <bruce@momjian.us>
Cc: Pavel Golub <pavel@gf.microolap.com>, pgsql-docs@postgresql.org
Subject: Re: Lack of docs for libpq C Library
Message-ID: <20080131152736.GG8602@alvh.no-ip.org>
References: <434340074.20080131112041@gf.microolap.com>
	<200801311509.m0VF9Xp23007@momjian.us>
MIME-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
In-Reply-To: <200801311509.m0VF9Xp23007@momjian.us>
User-Agent: Mutt/1.5.17+20080114 (2008-01-14)

Bruce Momjian wrote:
> Pavel Golub wrote:
> > Hello, pgsql-docs.
> > 
> > I noticed that some exported functions are not documented in the
> > Chapter 30. However, there are some info about them in other chapters,
> > e.g. PQclientEncoding using is described in chapter 22.2.3 "Automatic
> > Character Set Conversion Between Server and Client".
> 
> Though they are exported, the are more for internal use, e.g. psql,
> rather than something we want people using --- they can change from
> release to release.

I disagree.  I think PQinitSSL is meant to be called from the
application, for example.  Same with PQsetClientEncoding.  And the
PQExpBuffer stuff is all very useful, and years ago when I wrote an app
to use it it annoyed me that there were no docs on it.  (Back then, I
didn't realize I could have complained about it or written the docs
myself).


> ---------------------------------------------------------------------------
> 
> 
> > 
> > This is the list of exported functions without docs:
> > ================
> > PQclientEncoding
> > PQsetClientEncoding
> > PQconninfoFree
> > PQdsplen
> > PQenv2encoding
> > PQinitSSL
> > PQmblen
> > PQregisterThreadLock
> > appendPQExpBuffer
> > appendPQExpBufferChar
> > appendPQExpBufferStr
> > createPQExpBuffer
> > destroyPQExpBuffer
> > enlargePQExpBuffer
> > initPQExpBuffer
> > appendBinaryPQExpBuffer
> > pg_char_to_encoding
> > pg_encoding_to_char
> > pg_utf_mblen
> > pg_valid_server_encoding
> > pgresStatus
> > pqsignal
> > printfPQExpBuffer
> > resetPQExpBuffer
> > termPQExpBuffer


-- 
Alvaro Herrera                                http://www.CommandPrompt.com/
The PostgreSQL Company - Command Prompt, Inc.