Received: from localhost (unknown [200.46.204.183]) by postgresql.org (Postfix) with ESMTP id 73EB52E2F10 for ; Thu, 31 Jan 2008 12:01:57 -0400 (AST) Received: from postgresql.org ([200.46.204.71]) by localhost (mx1.hub.org [200.46.204.183]) (amavisd-maia, port 10024) with ESMTP id 31145-01-2 for ; Thu, 31 Jan 2008 12:01:52 -0400 (AST) Received: from momjian.us (momjian.us [70.90.9.53]) by postgresql.org (Postfix) with ESMTP id C258A2E02CF for ; Thu, 31 Jan 2008 12:01:24 -0400 (AST) Received: (from bruce@localhost) by momjian.us (8.11.6/8.11.6) id m0VG1Mh28607; Thu, 31 Jan 2008 11:01:22 -0500 (EST) From: Bruce Momjian Message-Id: <200801311601.m0VG1Mh28607@momjian.us> Subject: Re: Lack of docs for libpq C Library In-Reply-To: <20080131152736.GG8602@alvh.no-ip.org> To: Alvaro Herrera Date: Thu, 31 Jan 2008 11:01:22 -0500 (EST) CC: Pavel Golub , pgsql-docs@postgresql.org X-Mailer: ELM [version 2.4ME+ PL124 (25)] MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Content-Type: text/plain; charset="US-ASCII" X-Virus-Scanned: Maia Mailguard 1.0.1 X-Archive-Number: 200801/47 X-Sequence-Number: 4776 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 http://momjian.us EnterpriseDB http://postgres.enterprisedb.com + If your life is a hard drive, Christ can be your backup. +