Message-ID: <4C1B9735.2040505@enterprisedb.com>
Date: Fri, 18 Jun 2010 18:56:37 +0300
From: Heikki Linnakangas <heikki.linnakangas@enterprisedb.com>
Organization: EnterpriseDB
User-Agent: Mozilla/5.0 (X11; U; Linux i686; fi-FI;
	rv:1.9.1.9) Gecko/20100515 Iceowl/1.0b1 Icedove/3.0.4
MIME-Version: 1.0
To: Satoshi Nagayasu <satoshi.nagayasu@gmail.com>
CC: pgsql-interfaces@postgresql.org, pgsql-docs@postgresql.org,
	Bruce Momjian <bruce@momjian.us>, Michael Meskes <meskes@postgresql.org>
Subject: Re: ECPG Documentation Improvement
References: <4C19E5B9.3040002@gmail.com>
In-Reply-To: <4C19E5B9.3040002@gmail.com>
Content-Type: text/plain; charset=ISO-2022-JP
Content-Transfer-Encoding: 7bit

On 17/06/10 12:07, Satoshi Nagayasu wrote:
> I think it could be useful for the ECPG application developers,
> similar to the SQL reference section in the official manual.
> 
> ecpgdocs @ GoogleCode (I'm working here.)
> http://code.google.com/p/ecpgdocs/
> 
> ecpgdocs downloads (You can find the current document.)
> http://code.google.com/p/ecpgdocs/downloads/list?deleted=1&ts=1276763948
> 
> However, I'm not familiar with ECPG details or internals,
> so here is one asking, I hope someone to review my documents
> and give some feedback to me.
> 
> Feedbacks which I'm expecting are:
> 
> - Is this document useful?
> - Missing directives.
> - Missing or wrong synopsis.
> - More appropriate descriptions on parameters or examples.
> - How to contribute this to the official manual.
> - Correcting English. (sorry for my poor English.)
> - etc...
> 
> Honestly, I'm not familiar with the documentation acceptance/review process,
> so any advice and/or comments are welcome.

A reference of all the directives seems useful, but it seems at least
partially redundant with what's there already. WHENEVER for example is
quite well documented at
http://www.postgresql.org/docs/current/interactive/ecpg-errors.html already.

-- 
  Heikki Linnakangas
  EnterpriseDB   http://www.enterprisedb.com