public inbox for [email protected]  

help / color / mirror / Atom feed

From: Bruce Momjian <[email protected]>
To: Alvaro Herrera <[email protected]>
Cc: Pavel Golub <[email protected]>
Cc: [email protected]
Subject: Re: Lack of docs for libpq C Library
Date: Thu, 31 Jan 2008 11:01:22 -0500 (EST)
Message-ID: <[email protected]> (raw)
In-Reply-To: <[email protected]>

Alvaro Herrera wrote:
> 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

I see PQinitSSL and PQsetClientEncoding mentioned in the documentation; 
is it lacking enough detail?

> 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).

True but we don't guarantee the API of many of these functions like we
do the documented ones.

---------------------------------------------------------------------------


> 
> 
> > ---------------------------------------------------------------------------
> > 
> > 
> > > 
> > > 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.
> 
> ---------------------------(end of broadcast)---------------------------
> TIP 9: In versions below 8.0, the planner will ignore your desire to
>        choose an index scan if your joining column's datatypes do not
>        match

-- 
  Bruce Momjian  <[email protected]>        http://momjian.us
  EnterpriseDB                             http://postgres.enterprisedb.com

  + If your life is a hard drive, Christ can be your backup. +

view thread (25+ messages)  latest in thread

reply

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Reply to all the recipients using the --to and --cc options:
  reply via email

  To: [email protected]
  Cc: [email protected], [email protected], [email protected]
  Subject: Re: Lack of docs for libpq C Library
  In-Reply-To: <[email protected]>

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

This inbox is served by agora; see mirroring instructions
for how to clone and mirror all data and code used for this inbox