pg.ddx.io pgsql-docs@postgresql.org mailing list archive
help / color / mirror / Atom feedMissing file is mentioned on page https://www.postgresql.org/docs/13/libpq-exec.html
10+ messages / 4 participants
[nested] [flat]
* Missing file is mentioned on page https://www.postgresql.org/docs/13/libpq-exec.html
@ 2020-10-27 10:48 PG Doc comments form <noreply@postgresql.org>
0 siblings, 1 reply; 10+ messages in thread
From: PG Doc comments form @ 2020-10-27 10:48 UTC (permalink / raw)
To: pgsql-docs@lists.postgresql.org; +Cc: e.indrupskaya@postgrespro.ru
The following documentation comment has been logged on the website:
Page: https://www.postgresql.org/docs/13/libpq-exec.html
Description:
On page https://www.postgresql.org/docs/13/libpq-exec.html, non-existing
file is mentioned: src/include/catalog/pg_type_d.h. We fail to find it in
this catalog:
https://git.postgresql.org/gitweb/?p=postgresql.git;a=tree;f=src/include/catalog;hb=HEAD.
^ permalink raw reply [nested|flat] 10+ messages in thread
* Re: Missing file is mentioned on page https://www.postgresql.org/docs/13/libpq-exec.html
@ 2020-10-27 16:54 Bruce Momjian <bruce@momjian.us>
parent: PG Doc comments form <noreply@postgresql.org>
0 siblings, 1 reply; 10+ messages in thread
From: Bruce Momjian @ 2020-10-27 16:54 UTC (permalink / raw)
To: e.indrupskaya@postgrespro.ru; pgsql-docs@lists.postgresql.org
On Tue, Oct 27, 2020 at 10:48:00AM +0000, PG Doc comments form wrote:
> The following documentation comment has been logged on the website:
>
> Page: https://www.postgresql.org/docs/13/libpq-exec.html
> Description:
>
> On page https://www.postgresql.org/docs/13/libpq-exec.html, non-existing
> file is mentioned: src/include/catalog/pg_type_d.h. We fail to find it in
> this catalog:
> https://git.postgresql.org/gitweb/?p=postgresql.git;a=tree;f=src/include/catalog;hb=HEAD.
Uh, in my source tree that is a symlink to
src/backend/catalog/pg_type_d.h, but that file is generated by
src/backend/catalog/genbki.pl. Does that help you?
--
Bruce Momjian <bruce@momjian.us> https://momjian.us
EnterpriseDB https://enterprisedb.com
The usefulness of a cup is in its emptiness, Bruce Lee
^ permalink raw reply [nested|flat] 10+ messages in thread
* Re: Missing file is mentioned on page https://www.postgresql.org/docs/13/libpq-exec.html
@ 2020-10-30 15:01 Euler Taveira <euler.taveira@2ndquadrant.com>
parent: Bruce Momjian <bruce@momjian.us>
0 siblings, 1 reply; 10+ messages in thread
From: Euler Taveira @ 2020-10-30 15:01 UTC (permalink / raw)
To: Bruce Momjian <bruce@momjian.us>; +Cc: e.indrupskaya@postgrespro.ru; pgsql-docs@lists.postgresql.org
On Tue, 27 Oct 2020 at 13:54, Bruce Momjian <bruce@momjian.us> wrote:
> On Tue, Oct 27, 2020 at 10:48:00AM +0000, PG Doc comments form wrote:
> > The following documentation comment has been logged on the website:
> >
> > Page: https://www.postgresql.org/docs/13/libpq-exec.html
> > Description:
> >
> > On page https://www.postgresql.org/docs/13/libpq-exec.html, non-existing
> > file is mentioned: src/include/catalog/pg_type_d.h. We fail to find it in
> > this catalog:
> >
> https://git.postgresql.org/gitweb/?p=postgresql.git;a=tree;f=src/include/catalog;hb=HEAD
> .
>
> Uh, in my source tree that is a symlink to
> src/backend/catalog/pg_type_d.h, but that file is generated by
> src/backend/catalog/genbki.pl. Does that help you?
>
>
Shouldn't we replace "are defined in the file" with "are defined in the
generated file"? That's the only place that mentions *_d.h files. Perhaps
adding a link to BKI [1] should avoid further questions.
[1] https://www.postgresql.org/docs/13/bki.html
--
Euler Taveira http://www.2ndQuadrant.com/
PostgreSQL Development, 24x7 Support, Remote DBA, Training & Services
^ permalink raw reply [nested|flat] 10+ messages in thread
* Re: Missing file is mentioned on page https://www.postgresql.org/docs/13/libpq-exec.html
@ 2020-10-30 15:09 Tom Lane <tgl@sss.pgh.pa.us>
parent: Euler Taveira <euler.taveira@2ndquadrant.com>
0 siblings, 1 reply; 10+ messages in thread
From: Tom Lane @ 2020-10-30 15:09 UTC (permalink / raw)
To: Euler Taveira <euler.taveira@2ndquadrant.com>; +Cc: Bruce Momjian <bruce@momjian.us>; e.indrupskaya@postgrespro.ru; pgsql-docs@lists.postgresql.org
Euler Taveira <euler.taveira@2ndquadrant.com> writes:
> On Tue, 27 Oct 2020 at 13:54, Bruce Momjian <bruce@momjian.us> wrote:
>> Uh, in my source tree that is a symlink to
>> src/backend/catalog/pg_type_d.h, but that file is generated by
>> src/backend/catalog/genbki.pl. Does that help you?
> Shouldn't we replace "are defined in the file" with "are defined in the
> generated file"? That's the only place that mentions *_d.h files. Perhaps
> adding a link to BKI [1] should avoid further questions.
It'd probably confuse users more, actually. This chapter is aimed at
users of Postgres, not developers.
^ permalink raw reply [nested|flat] 10+ messages in thread
* Re: Missing file is mentioned on page https://www.postgresql.org/docs/13/libpq-exec.html
@ 2020-11-10 23:06 Bruce Momjian <bruce@momjian.us>
parent: Tom Lane <tgl@sss.pgh.pa.us>
0 siblings, 1 reply; 10+ messages in thread
From: Bruce Momjian @ 2020-11-10 23:06 UTC (permalink / raw)
To: Tom Lane <tgl@sss.pgh.pa.us>; +Cc: Euler Taveira <euler.taveira@2ndquadrant.com>; e.indrupskaya@postgrespro.ru; pgsql-docs@lists.postgresql.org
On Fri, Oct 30, 2020 at 11:09:58AM -0400, Tom Lane wrote:
> Euler Taveira <euler.taveira@2ndquadrant.com> writes:
> > On Tue, 27 Oct 2020 at 13:54, Bruce Momjian <bruce@momjian.us> wrote:
> >> Uh, in my source tree that is a symlink to
> >> src/backend/catalog/pg_type_d.h, but that file is generated by
> >> src/backend/catalog/genbki.pl. Does that help you?
>
> > Shouldn't we replace "are defined in the file" with "are defined in the
> > generated file"? That's the only place that mentions *_d.h files. Perhaps
> > adding a link to BKI [1] should avoid further questions.
>
> It'd probably confuse users more, actually. This chapter is aimed at
> users of Postgres, not developers.
>
> >From a user's viewpoint, catalog/pg_type_d.h should look pretty much
> like any other installed header. We want to point them at that, not at
> pg_type.h, because the latter is painful to include in application code
> that doesn't want to buy into the Postgres programming environment
> altogether.
>
> Thinking about it from the perspective of someone dealing with an
> installation tree not a source tree, maybe the reference should
> be to "server/catalog/pg_type_d.h". That might help disabuse
> anyone who's expecting to find it at that path in the git tree.
I am confused what the "server/" prefix means in a path name.
We currently say:
The <acronym>OID</acronym>s of the built-in data types are defined in
the file <filename>src/include/catalog/pg_type_d.h</filename> in the
source tree.
We could add "compiled":
The <acronym>OID</acronym>s of the built-in data types are defined in
the file <filename>src/include/catalog/pg_type_d.h</filename> in the
source tree after it is compiled.
--------------------
--
Bruce Momjian <bruce@momjian.us> https://momjian.us
EnterpriseDB https://enterprisedb.com
The usefulness of a cup is in its emptiness, Bruce Lee
^ permalink raw reply [nested|flat] 10+ messages in thread
* Re: Missing file is mentioned on page https://www.postgresql.org/docs/13/libpq-exec.html
@ 2020-11-10 23:15 Tom Lane <tgl@sss.pgh.pa.us>
parent: Bruce Momjian <bruce@momjian.us>
0 siblings, 2 replies; 10+ messages in thread
From: Tom Lane @ 2020-11-10 23:15 UTC (permalink / raw)
To: Bruce Momjian <bruce@momjian.us>; +Cc: Euler Taveira <euler.taveira@2ndquadrant.com>; e.indrupskaya@postgrespro.ru; pgsql-docs@lists.postgresql.org
Bruce Momjian <bruce@momjian.us> writes:
> On Fri, Oct 30, 2020 at 11:09:58AM -0400, Tom Lane wrote:
>> Thinking about it from the perspective of someone dealing with an
>> installation tree not a source tree, maybe the reference should
>> be to "server/catalog/pg_type_d.h". That might help disabuse
>> anyone who's expecting to find it at that path in the git tree.
> I am confused what the "server/" prefix means in a path name.
That is the path underneath the installation "include" directory
at which that file will be found.
> We currently say:
> The <acronym>OID</acronym>s of the built-in data types are defined in
> the file <filename>src/include/catalog/pg_type_d.h</filename> in the
> source tree.
Yeah, so also s/source tree/install tree/.
regards, tom lane
^ permalink raw reply [nested|flat] 10+ messages in thread
* Re: Missing file is mentioned on page https://www.postgresql.org/docs/13/libpq-exec.html
@ 2020-11-10 23:24 Bruce Momjian <bruce@momjian.us>
parent: Tom Lane <tgl@sss.pgh.pa.us>
1 sibling, 1 reply; 10+ messages in thread
From: Bruce Momjian @ 2020-11-10 23:24 UTC (permalink / raw)
To: Tom Lane <tgl@sss.pgh.pa.us>; +Cc: Euler Taveira <euler.taveira@2ndquadrant.com>; e.indrupskaya@postgrespro.ru; pgsql-docs@lists.postgresql.org
On Tue, Nov 10, 2020 at 06:15:29PM -0500, Tom Lane wrote:
> Bruce Momjian <bruce@momjian.us> writes:
> > On Fri, Oct 30, 2020 at 11:09:58AM -0400, Tom Lane wrote:
> >> Thinking about it from the perspective of someone dealing with an
> >> installation tree not a source tree, maybe the reference should
> >> be to "server/catalog/pg_type_d.h". That might help disabuse
> >> anyone who's expecting to find it at that path in the git tree.
>
> > I am confused what the "server/" prefix means in a path name.
>
> That is the path underneath the installation "include" directory
> at which that file will be found.
Uh, I don't see it:
$ ls -w 80 /usr/local/pgsql/include/
ecpg_config.h libpq pgtypes_date.h server
ecpgerrno.h libpq-events.h pgtypes_error.h sql3types.h
ecpg_informix.h libpq-fe.h pgtypes.h sqlca.h
ecpglib.h pg_config_ext.h pgtypes_interval.h sqlda-compat.h
ecpgtype.h pg_config.h pgtypes_numeric.h sqlda.h
informix pg_config_manual.h pgtypes_timestamp.h sqlda-native.h
internal pg_config_os.h postgres_ext.h
--
Bruce Momjian <bruce@momjian.us> https://momjian.us
EnterpriseDB https://enterprisedb.com
The usefulness of a cup is in its emptiness, Bruce Lee
^ permalink raw reply [nested|flat] 10+ messages in thread
* Re: Missing file is mentioned on page https://www.postgresql.org/docs/13/libpq-exec.html
@ 2020-11-11 00:11 Tom Lane <tgl@sss.pgh.pa.us>
parent: Bruce Momjian <bruce@momjian.us>
0 siblings, 0 replies; 10+ messages in thread
From: Tom Lane @ 2020-11-11 00:11 UTC (permalink / raw)
To: Bruce Momjian <bruce@momjian.us>; +Cc: Euler Taveira <euler.taveira@2ndquadrant.com>; e.indrupskaya@postgrespro.ru; pgsql-docs@lists.postgresql.org
Bruce Momjian <bruce@momjian.us> writes:
> On Tue, Nov 10, 2020 at 06:15:29PM -0500, Tom Lane wrote:
>> That is the path underneath the installation "include" directory
>> at which that file will be found.
> Uh, I don't see it:
> $ ls -w 80 /usr/local/pgsql/include/
> ecpg_config.h libpq pgtypes_date.h server
^^^^^^
You didn't do "ls -R", but I have every confidence that it's underneath
there.
regards, tom lane
^ permalink raw reply [nested|flat] 10+ messages in thread
* Re: Missing file is mentioned on page https://www.postgresql.org/docs/13/libpq-exec.html
@ 2020-11-11 00:23 Bruce Momjian <bruce@momjian.us>
parent: Tom Lane <tgl@sss.pgh.pa.us>
1 sibling, 1 reply; 10+ messages in thread
From: Bruce Momjian @ 2020-11-11 00:23 UTC (permalink / raw)
To: Tom Lane <tgl@sss.pgh.pa.us>; +Cc: Euler Taveira <euler.taveira@2ndquadrant.com>; e.indrupskaya@postgrespro.ru; pgsql-docs@lists.postgresql.org
On Tue, Nov 10, 2020 at 06:15:29PM -0500, Tom Lane wrote:
> Bruce Momjian <bruce@momjian.us> writes:
> > On Fri, Oct 30, 2020 at 11:09:58AM -0400, Tom Lane wrote:
> >> Thinking about it from the perspective of someone dealing with an
> >> installation tree not a source tree, maybe the reference should
> >> be to "server/catalog/pg_type_d.h". That might help disabuse
> >> anyone who's expecting to find it at that path in the git tree.
>
> > I am confused what the "server/" prefix means in a path name.
>
> That is the path underneath the installation "include" directory
> at which that file will be found.
Yep, it's there. I thought I checked for an include/catalog install
directory, but obviously not well enough.
> > We currently say:
>
> > The <acronym>OID</acronym>s of the built-in data types are defined in
> > the file <filename>src/include/catalog/pg_type_d.h</filename> in the
> > source tree.
>
> Yeah, so also s/source tree/install tree/.
OK, here is a patch that mentions both.
--
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.diff (text/x-diff, 712B) download
diff --git a/doc/src/sgml/libpq.sgml b/doc/src/sgml/libpq.sgml
index 9ce32fb39b..73c6a6ea4d 100644
--- a/doc/src/sgml/libpq.sgml
+++ b/doc/src/sgml/libpq.sgml
@@ -3666,8 +3666,8 @@ Oid PQftype(const PGresult *res,
You can query the system table <literal>pg_type</literal> to
obtain the names and properties of the various data types. The
<acronym>OID</acronym>s of the built-in data types are defined
- in the file <filename>src/include/catalog/pg_type_d.h</filename>
- in the source tree.
+ in the file <filename>include/catalog/pg_type_d.h</filename>
+ in the compiled source directory and install directory.
</para>
</listitem>
</varlistentry>
* Re: Missing file is mentioned on page https://www.postgresql.org/docs/13/libpq-exec.html
@ 2020-11-12 20:13 Bruce Momjian <bruce@momjian.us>
parent: Bruce Momjian <bruce@momjian.us>
0 siblings, 0 replies; 10+ messages in thread
From: Bruce Momjian @ 2020-11-12 20:13 UTC (permalink / raw)
To: Tom Lane <tgl@sss.pgh.pa.us>; +Cc: Euler Taveira <euler.taveira@2ndquadrant.com>; e.indrupskaya@postgrespro.ru; pgsql-docs@lists.postgresql.org
On Tue, Nov 10, 2020 at 07:23:12PM -0500, Bruce Momjian wrote:
> On Tue, Nov 10, 2020 at 06:15:29PM -0500, Tom Lane wrote:
> > Bruce Momjian <bruce@momjian.us> writes:
> > > On Fri, Oct 30, 2020 at 11:09:58AM -0400, Tom Lane wrote:
> > >> Thinking about it from the perspective of someone dealing with an
> > >> installation tree not a source tree, maybe the reference should
> > >> be to "server/catalog/pg_type_d.h". That might help disabuse
> > >> anyone who's expecting to find it at that path in the git tree.
> >
> > > I am confused what the "server/" prefix means in a path name.
> >
> > That is the path underneath the installation "include" directory
> > at which that file will be found.
>
> Yep, it's there. I thought I checked for an include/catalog install
> directory, but obviously not well enough.
>
> > > We currently say:
> >
> > > The <acronym>OID</acronym>s of the built-in data types are defined in
> > > the file <filename>src/include/catalog/pg_type_d.h</filename> in the
> > > source tree.
> >
> > Yeah, so also s/source tree/install tree/.
>
> OK, here is a patch that mentions both.
Adjusted patch applied to all branches.
--
Bruce Momjian <bruce@momjian.us> https://momjian.us
EnterpriseDB https://enterprisedb.com
The usefulness of a cup is in its emptiness, Bruce Lee
^ permalink raw reply [nested|flat] 10+ messages in thread
end of thread, other threads:[~2020-11-12 20:13 UTC | newest]
Thread overview: 10+ messages (download: mbox mbox.gz follow: Atom feed)
-- links below jump to the message on this page --
2020-10-27 10:48 Missing file is mentioned on page https://www.postgresql.org/docs/13/libpq-exec.html PG Doc comments form <noreply@postgresql.org>
2020-10-27 16:54 ` Bruce Momjian <bruce@momjian.us>
2020-10-30 15:01 ` Euler Taveira <euler.taveira@2ndquadrant.com>
2020-10-30 15:09 ` Tom Lane <tgl@sss.pgh.pa.us>
2020-11-10 23:06 ` Bruce Momjian <bruce@momjian.us>
2020-11-10 23:15 ` Tom Lane <tgl@sss.pgh.pa.us>
2020-11-10 23:24 ` Bruce Momjian <bruce@momjian.us>
2020-11-11 00:11 ` Tom Lane <tgl@sss.pgh.pa.us>
2020-11-11 00:23 ` Bruce Momjian <bruce@momjian.us>
2020-11-12 20:13 ` Bruce Momjian <bruce@momjian.us>
This inbox is served by DDX for PostgreSQL; see mirroring instructions
for how to clone and mirror all data and code used for this inbox