pgsql: doc: clarify where to find pg_type_d.h (PG 11+) and pg_type.h

Started by Bruce Momjianover 5 years ago4 messagescomitters
Jump to latest
#1Bruce Momjian
bruce@momjian.us

doc: clarify where to find pg_type_d.h (PG 11+) and pg_type.h

These files are in compiled directories and install directories.

Reported-by: e.indrupskaya@postgrespro.ru

Discussion: /messages/by-id/160379609706.24746.7506163279454026608@wrigleys.postgresql.org

Backpatch-through: 9.5

Branch
------
master

Details
-------
https://git.postgresql.org/pg/commitdiff/152ed04799e31e9abe6c2ed8afc7405b892b7d86

Modified Files
--------------
doc/src/sgml/libpq.sgml | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)

#2Alvaro Herrera
alvherre@2ndquadrant.com
In reply to: Bruce Momjian (#1)
Re: pgsql: doc: clarify where to find pg_type_d.h (PG 11+) and pg_type.h

On 2020-Nov-12, Bruce Momjian wrote:

doc: clarify where to find pg_type_d.h (PG 11+) and pg_type.h

These files are in compiled directories and install directories.

I think this patch is wrong, because in the install tree the files are in
the server/ subdir. It should read:

The <acronym>OID</acronym>s of the built-in data types are defined in
the file <filename>include/catalog/pg_type_d.h</filename> in the
compiled source directory, and in
<filename>include/server/catalog/pg_type_d.h</filename> in the install
directory.

That said, if the user is doing a VPATH build, then "compiled source
directory" is a confusing way to say "the build directory", and I don't
think it's an important location anyway, first because it's really a
throwaway directory, and second it's not even there in a packaged
installation; users just care about the *installed* file, don't they?
So I suggest to rip that part out, and leave just:

The <acronym>OID</acronym>s of the built-in data types are defined in
the file <filename>include/server/catalog/pg_type_d.h</filename> in the
install directory.

#3Bruce Momjian
bruce@momjian.us
In reply to: Alvaro Herrera (#2)
Re: pgsql: doc: clarify where to find pg_type_d.h (PG 11+) and pg_type.h

On Thu, Nov 12, 2020 at 05:29:00PM -0300, �lvaro Herrera wrote:

On 2020-Nov-12, Bruce Momjian wrote:

doc: clarify where to find pg_type_d.h (PG 11+) and pg_type.h

These files are in compiled directories and install directories.

I think this patch is wrong, because in the install tree the files are in
the server/ subdir. It should read:

The <acronym>OID</acronym>s of the built-in data types are defined in
the file <filename>include/catalog/pg_type_d.h</filename> in the
compiled source directory, and in
<filename>include/server/catalog/pg_type_d.h</filename> in the install
directory.

That said, if the user is doing a VPATH build, then "compiled source
directory" is a confusing way to say "the build directory", and I don't
think it's an important location anyway, first because it's really a
throwaway directory, and second it's not even there in a packaged
installation; users just care about the *installed* file, don't they?
So I suggest to rip that part out, and leave just:

The <acronym>OID</acronym>s of the built-in data types are defined in
the file <filename>include/server/catalog/pg_type_d.h</filename> in the
install directory.

OK, how is this followup patch?

--
Bruce Momjian <bruce@momjian.us> https://momjian.us
EnterpriseDB https://enterprisedb.com

The usefulness of a cup is in its emptiness, Bruce Lee

Attachments:

pg_type-v2.difftext/x-diff; charset=us-asciiDownload+2-2
#4Bruce Momjian
bruce@momjian.us
In reply to: Bruce Momjian (#3)
Re: pgsql: doc: clarify where to find pg_type_d.h (PG 11+) and pg_type.h

On Thu, Nov 12, 2020 at 06:15:51PM -0500, Bruce Momjian wrote:

On Thu, Nov 12, 2020 at 05:29:00PM -0300, �lvaro Herrera wrote:

On 2020-Nov-12, Bruce Momjian wrote:

doc: clarify where to find pg_type_d.h (PG 11+) and pg_type.h

These files are in compiled directories and install directories.

I think this patch is wrong, because in the install tree the files are in
the server/ subdir. It should read:

The <acronym>OID</acronym>s of the built-in data types are defined in
the file <filename>include/catalog/pg_type_d.h</filename> in the
compiled source directory, and in
<filename>include/server/catalog/pg_type_d.h</filename> in the install
directory.

That said, if the user is doing a VPATH build, then "compiled source
directory" is a confusing way to say "the build directory", and I don't
think it's an important location anyway, first because it's really a
throwaway directory, and second it's not even there in a packaged
installation; users just care about the *installed* file, don't they?
So I suggest to rip that part out, and leave just:

The <acronym>OID</acronym>s of the built-in data types are defined in
the file <filename>include/server/catalog/pg_type_d.h</filename> in the
install directory.

OK, how is this followup patch?

Applied to all branches, thanks.

--
Bruce Momjian <bruce@momjian.us> https://momjian.us
EnterpriseDB https://enterprisedb.com

The usefulness of a cup is in its emptiness, Bruce Lee