SPI not defined.

Started by PG Bug reporting formabout 8 years ago11 messagesdocs
Jump to latest
#1PG Bug reporting form
noreply@postgresql.org

The following documentation comment has been logged on the website:

Page: https://www.postgresql.org/docs/9.5/static/contrib-spi.html
Description:

In the appendix for Additional Supplied Modules there is a module spi. If
you click through the page for that module it never defines what spi is. If
you search for PostgreSQL spi you get the page that doesn't define it and
some other information on the PostgreSQL Server Programming Interface, which
I think is a different SPI. I would recommend that the module page define
the spi acronym.

#2David G. Johnston
david.g.johnston@gmail.com
In reply to: PG Bug reporting form (#1)
Re: SPI not defined.

On Monday, January 29, 2018, PG Doc comments form <noreply@postgresql.org>
wrote:

The following documentation comment has been logged on the website:

Page: https://www.postgresql.org/docs/9.5/static/contrib-spi.html
Description:

In the appendix for Additional Supplied Modules there is a module spi. If
you click through the page for that module it never defines what spi is.
If
you search for PostgreSQL spi you get the page that doesn't define it and
some other information on the PostgreSQL Server Programming Interface,
which
I think is a different SPI.

No, SPI in that module is indeed "Server Programming Interface".

I would recommend that the module page define

the spi acronym.

Seems reasonable.

David J.

#3Bruce Momjian
bruce@momjian.us
In reply to: David G. Johnston (#2)
Re: SPI not defined.

On Mon, Jan 29, 2018 at 03:07:06PM -0700, David G. Johnston wrote:

On Monday, January 29, 2018, PG Doc comments form <noreply@postgresql.org>
No, SPI in that module is indeed "Server Programming Interface".

� I would recommend that the module page define

the spi acronym.

Seems reasonable.

How is the attached patch?

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

+ As you are, so once was I.  As I am, so you will be. +
+                      Ancient Roman grave inscription +

Attachments:

spi.difftext/x-diff; charset=us-asciiDownload+3-3
#4David G. Johnston
david.g.johnston@gmail.com
In reply to: Bruce Momjian (#3)
Re: SPI not defined.

On Monday, January 29, 2018, Bruce Momjian <bruce@momjian.us> wrote:

How is the attached patch?

Maybe add a link to:

https://www.postgresql.org/docs/10/static/spi.html

Also, on that page, the error handling mechanisms have been "in flux" since
8.0 ... ?

" This is not currently documented because the mechanisms required are
still in flux. "

David J.

#5Tom Lane
tgl@sss.pgh.pa.us
In reply to: Bruce Momjian (#3)
Re: SPI not defined.

Bruce Momjian <bruce@momjian.us> writes:

How is the attached patch?

Maybe also make that text into a hyperlink to the SPI manual chapter?

regards, tom lane

#6Bruce Momjian
bruce@momjian.us
In reply to: David G. Johnston (#4)
Re: SPI not defined.

On Mon, Jan 29, 2018 at 08:39:22PM -0700, David G. Johnston wrote:

On Monday, January 29, 2018, Bruce Momjian <bruce@momjian.us> wrote:

How is the attached patch?

Maybe add a link to:

�https://www.postgresql.org/docs/10/static/spi.html

Also, on that page, the error handling mechanisms have been "in flux" since 8.0
... ?

"�This is not currently documented because the mechanisms required are still in
flux. "

OK, updated patch with both fixes.

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

+ As you are, so once was I.  As I am, so you will be. +
+                      Ancient Roman grave inscription +

Attachments:

spi.difftext/x-diff; charset=us-asciiDownload+3-3
#7Bruce Momjian
bruce@momjian.us
In reply to: Tom Lane (#5)
Re: SPI not defined.

On Mon, Jan 29, 2018 at 10:51:59PM -0500, Tom Lane wrote:

Bruce Momjian <bruce@momjian.us> writes:

How is the attached patch?

Maybe also make that text into a hyperlink to the SPI manual chapter?

Yes, that's what I just did in the new patch.

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

+ As you are, so once was I.  As I am, so you will be. +
+                      Ancient Roman grave inscription +
#8David G. Johnston
david.g.johnston@gmail.com
In reply to: Bruce Momjian (#7)
Re: SPI not defined.

On Mon, Jan 29, 2018 at 8:55 PM, Bruce Momjian <bruce@momjian.us> wrote:

On Mon, Jan 29, 2018 at 10:51:59PM -0500, Tom Lane wrote:

Bruce Momjian <bruce@momjian.us> writes:

How is the attached patch?

Maybe also make that text into a hyperlink to the SPI manual chapter?

Yes, that's what I just did in the new patch.

​Your second attachment is the same as the first.

Dave​

#9Tom Lane
tgl@sss.pgh.pa.us
In reply to: Bruce Momjian (#6)
Re: SPI not defined.

Bruce Momjian <bruce@momjian.us> writes:

OK, updated patch with both fixes.

AFAICS that's the same patch you posted before.

regards, tom lane

#10Bruce Momjian
bruce@momjian.us
In reply to: David G. Johnston (#8)
Re: SPI not defined.

On Mon, Jan 29, 2018 at 08:58:10PM -0700, David G. Johnston wrote:

On Mon, Jan 29, 2018 at 8:55 PM, Bruce Momjian <bruce@momjian.us> wrote:

On Mon, Jan 29, 2018 at 10:51:59PM -0500, Tom Lane wrote:

Bruce Momjian <bruce@momjian.us> writes:

How is the attached patch?

Maybe also make that text into a hyperlink to the SPI manual chapter?

Yes, that's what I just did in the new patch.

​Your second attachment is the same as the first.

Oops, here is the right one.

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

+ As you are, so once was I.  As I am, so you will be. +
+                      Ancient Roman grave inscription +

Attachments:

spi.difftext/x-diff; charset=us-asciiDownload+7-7
#11Bruce Momjian
bruce@momjian.us
In reply to: Bruce Momjian (#10)
Re: SPI not defined.

On Mon, Jan 29, 2018 at 11:03:32PM -0500, Bruce Momjian wrote:

On Mon, Jan 29, 2018 at 08:58:10PM -0700, David G. Johnston wrote:

On Mon, Jan 29, 2018 at 8:55 PM, Bruce Momjian <bruce@momjian.us> wrote:

On Mon, Jan 29, 2018 at 10:51:59PM -0500, Tom Lane wrote:

Bruce Momjian <bruce@momjian.us> writes:

How is the attached patch?

Maybe also make that text into a hyperlink to the SPI manual chapter?

Yes, that's what I just did in the new patch.

​Your second attachment is the same as the first.

Oops, here is the right one.

Done and backpatched through 9.3. Thanks for the feedback.

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

+ As you are, so once was I.  As I am, so you will be. +
+                      Ancient Roman grave inscription +