Re: ECPG - Some errno definitions don't match to the manual

From: Satoshi Nagayasu <satoshi(dot)nagayasu(at)gmail(dot)com>
To: Robert Haas <robertmhaas(at)gmail(dot)com>
Cc: pgsql-docs <pgsql-docs(at)postgresql(dot)org>, Michael Meskes <meskes(at)postgresql(dot)org>
Subject: Re: ECPG - Some errno definitions don't match to the manual
Date: 2010-08-09 16:36:45
Message-ID: 4C602E9D.40501@gmail.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs pgsql-general

On 2010/08/09 21:27, Robert Haas wrote:
>> I'm now investigating SQLCODE and SQLSTATE, and I have found
>> that some of the errno definitions don't match to the manual.

>> What does it mean? The manual is not up to date?
>
> Yeah, I think that's what it means. Perhaps you could provide a patch
> for the docs?

Sure, I will make a patch for this. Please wait a moment.

> Another question is whether we oughn't to remove all mention of the
> specific values of these constants from the documentation. That
> wouldn't prevent all problems in this area, because constants can
> still be added and removed, but ISTM that including the specific
> numerical values here is encouraging people to depend on those values
> when they probably shouldn't.

Hmm, it's a difficult point. From the application programmers' viewpoint, error codes and error numbers would be an interface between their application and PostgreSQL internals. So I think (and I hope) it should be in the programmer's manual. On the other hand, from the PostgreSQL developer's viewpoint, it is hard to maintain all of documents up to date. So removing them from the manual will make maintenance easier.

I found that this difference was generated by the very very old change in the code repository. And I think it would never be happen anymore, because nowadays PostgreSQL developers, especially code reviewers, always require "document updates/patches" for any patches before applying. (as all you know :)

I agree with that taking care about both code and documents is not so easy, but the current review/development process seems to be appropriate.

Any comments or suggestions?

--
NAGAYASU Satoshi <satoshi(dot)nagayasu(at)gmail(dot)com>

In response to

Responses

Browse pgsql-docs by date

  From Date Subject
Next Message Marko Kreen 2010-08-09 17:21:22 Re: Documentation improvement for PQgetResult
Previous Message Robert Haas 2010-08-09 12:32:48 Re: pgbench acronym tps

Browse pgsql-general by date

  From Date Subject
Next Message Joshua D. Drake 2010-08-09 16:46:06 Re: MySQL versus Postgres
Previous Message Randal L. Schwartz 2010-08-09 16:33:48 Re: MySQL versus Postgres