public inbox for [email protected]  
help / color / mirror / Atom feed
SPI not defined.
11+ messages / 4 participants
[nested] [flat]

* SPI not defined.
@ 2018-01-29 21:52  PG Doc comments form <[email protected]>
  0 siblings, 1 reply; 11+ messages in thread

From: PG Doc comments form @ 2018-01-29 21:52 UTC (permalink / raw)
  To: [email protected]; +Cc: [email protected]

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.


^ permalink  raw  reply  [nested|flat] 11+ messages in thread

* Re: SPI not defined.
@ 2018-01-29 22:07  David G. Johnston <[email protected]>
  parent: PG Doc comments form <[email protected]>
  0 siblings, 1 reply; 11+ messages in thread

From: David G. Johnston @ 2018-01-29 22:07 UTC (permalink / raw)
  To: [email protected] <[email protected]>; [email protected] <[email protected]>

On Monday, January 29, 2018, PG Doc comments form <[email protected]>
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.


^ permalink  raw  reply  [nested|flat] 11+ messages in thread

* Re: SPI not defined.
@ 2018-01-30 03:26  Bruce Momjian <[email protected]>
  parent: David G. Johnston <[email protected]>
  0 siblings, 2 replies; 11+ messages in thread

From: Bruce Momjian @ 2018-01-30 03:26 UTC (permalink / raw)
  To: David G. Johnston <[email protected]>; +Cc: [email protected] <[email protected]>; [email protected] <[email protected]>

On Mon, Jan 29, 2018 at 03:07:06PM -0700, David G. Johnston wrote:
> On Monday, January 29, 2018, PG Doc comments form <[email protected]>
> 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  <[email protected]>        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:

  [text/x-diff] spi.diff (1.0K, 2-spi.diff)
  download | inline diff:
diff --git a/doc/src/sgml/contrib-spi.sgml b/doc/src/sgml/contrib-spi.sgml
new file mode 100644
index 32c7105..2dc2d92
*** a/doc/src/sgml/contrib-spi.sgml
--- b/doc/src/sgml/contrib-spi.sgml
***************
*** 10,16 ****
  
   <para>
    The <application>spi</application> module provides several workable examples
!   of using SPI and triggers.  While these functions are of some value in
    their own right, they are even more useful as examples to modify for
    your own purposes.  The functions are general enough to be used
    with any table, but you have to specify table and field names (as described
--- 10,17 ----
  
   <para>
    The <application>spi</application> module provides several workable examples
!   of using the Server Programming Interface (<acronym>SPI</acronym>) and
!   triggers.  While these functions are of some value in
    their own right, they are even more useful as examples to modify for
    your own purposes.  The functions are general enough to be used
    with any table, but you have to specify table and field names (as described


^ permalink  raw  reply  [nested|flat] 11+ messages in thread

* Re: SPI not defined.
@ 2018-01-30 03:39  David G. Johnston <[email protected]>
  parent: Bruce Momjian <[email protected]>
  1 sibling, 1 reply; 11+ messages in thread

From: David G. Johnston @ 2018-01-30 03:39 UTC (permalink / raw)
  To: Bruce Momjian <[email protected]>; +Cc: [email protected] <[email protected]>; [email protected] <[email protected]>

On Monday, January 29, 2018, Bruce Momjian <[email protected]> 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.


^ permalink  raw  reply  [nested|flat] 11+ messages in thread

* Re: SPI not defined.
@ 2018-01-30 03:51  Tom Lane <[email protected]>
  parent: Bruce Momjian <[email protected]>
  1 sibling, 1 reply; 11+ messages in thread

From: Tom Lane @ 2018-01-30 03:51 UTC (permalink / raw)
  To: Bruce Momjian <[email protected]>; +Cc: David G. Johnston <[email protected]>; [email protected] <[email protected]>; [email protected] <[email protected]>

Bruce Momjian <[email protected]> writes:
> How is the attached patch?

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

			regards, tom lane




^ permalink  raw  reply  [nested|flat] 11+ messages in thread

* Re: SPI not defined.
@ 2018-01-30 03:54  Bruce Momjian <[email protected]>
  parent: David G. Johnston <[email protected]>
  0 siblings, 1 reply; 11+ messages in thread

From: Bruce Momjian @ 2018-01-30 03:54 UTC (permalink / raw)
  To: David G. Johnston <[email protected]>; +Cc: [email protected] <[email protected]>; [email protected] <[email protected]>

On Mon, Jan 29, 2018 at 08:39:22PM -0700, David G. Johnston wrote:
> On Monday, January 29, 2018, Bruce Momjian <[email protected]> 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  <[email protected]>        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:

  [text/x-diff] spi.diff (1.0K, 2-spi.diff)
  download | inline diff:
diff --git a/doc/src/sgml/contrib-spi.sgml b/doc/src/sgml/contrib-spi.sgml
new file mode 100644
index 32c7105..2dc2d92
*** a/doc/src/sgml/contrib-spi.sgml
--- b/doc/src/sgml/contrib-spi.sgml
***************
*** 10,16 ****
  
   <para>
    The <application>spi</application> module provides several workable examples
!   of using SPI and triggers.  While these functions are of some value in
    their own right, they are even more useful as examples to modify for
    your own purposes.  The functions are general enough to be used
    with any table, but you have to specify table and field names (as described
--- 10,17 ----
  
   <para>
    The <application>spi</application> module provides several workable examples
!   of using the Server Programming Interface (<acronym>SPI</acronym>) and
!   triggers.  While these functions are of some value in
    their own right, they are even more useful as examples to modify for
    your own purposes.  The functions are general enough to be used
    with any table, but you have to specify table and field names (as described


^ permalink  raw  reply  [nested|flat] 11+ messages in thread

* Re: SPI not defined.
@ 2018-01-30 03:55  Bruce Momjian <[email protected]>
  parent: Tom Lane <[email protected]>
  0 siblings, 1 reply; 11+ messages in thread

From: Bruce Momjian @ 2018-01-30 03:55 UTC (permalink / raw)
  To: Tom Lane <[email protected]>; +Cc: David G. Johnston <[email protected]>; [email protected] <[email protected]>; [email protected] <[email protected]>

On Mon, Jan 29, 2018 at 10:51:59PM -0500, Tom Lane wrote:
> Bruce Momjian <[email protected]> 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  <[email protected]>        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 +




^ permalink  raw  reply  [nested|flat] 11+ messages in thread

* Re: SPI not defined.
@ 2018-01-30 03:58  David G. Johnston <[email protected]>
  parent: Bruce Momjian <[email protected]>
  0 siblings, 1 reply; 11+ messages in thread

From: David G. Johnston @ 2018-01-30 03:58 UTC (permalink / raw)
  To: Bruce Momjian <[email protected]>; +Cc: Tom Lane <[email protected]>; [email protected] <[email protected]>; [email protected] <[email protected]>

On Mon, Jan 29, 2018 at 8:55 PM, Bruce Momjian <[email protected]> wrote:

> On Mon, Jan 29, 2018 at 10:51:59PM -0500, Tom Lane wrote:
> > Bruce Momjian <[email protected]> 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​


^ permalink  raw  reply  [nested|flat] 11+ messages in thread

* Re: SPI not defined.
@ 2018-01-30 03:58  Tom Lane <[email protected]>
  parent: Bruce Momjian <[email protected]>
  0 siblings, 0 replies; 11+ messages in thread

From: Tom Lane @ 2018-01-30 03:58 UTC (permalink / raw)
  To: Bruce Momjian <[email protected]>; +Cc: David G. Johnston <[email protected]>; [email protected] <[email protected]>; [email protected] <[email protected]>

Bruce Momjian <[email protected]> writes:
> OK, updated patch with both fixes.

AFAICS that's the same patch you posted before.

			regards, tom lane




^ permalink  raw  reply  [nested|flat] 11+ messages in thread

* Re: SPI not defined.
@ 2018-01-30 04:03  Bruce Momjian <[email protected]>
  parent: David G. Johnston <[email protected]>
  0 siblings, 1 reply; 11+ messages in thread

From: Bruce Momjian @ 2018-01-30 04:03 UTC (permalink / raw)
  To: David G. Johnston <[email protected]>; +Cc: Tom Lane <[email protected]>; [email protected] <[email protected]>; [email protected] <[email protected]>

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 <[email protected]> wrote:
> 
>     On Mon, Jan 29, 2018 at 10:51:59PM -0500, Tom Lane wrote:
>     > Bruce Momjian <[email protected]> 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  <[email protected]>        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:

  [text/x-diff] spi.diff (2.0K, 2-spi.diff)
  download | inline diff:
diff --git a/doc/src/sgml/contrib-spi.sgml b/doc/src/sgml/contrib-spi.sgml
new file mode 100644
index 32c7105..844ea16
*** a/doc/src/sgml/contrib-spi.sgml
--- b/doc/src/sgml/contrib-spi.sgml
***************
*** 10,16 ****
  
   <para>
    The <application>spi</application> module provides several workable examples
!   of using SPI and triggers.  While these functions are of some value in
    their own right, they are even more useful as examples to modify for
    your own purposes.  The functions are general enough to be used
    with any table, but you have to specify table and field names (as described
--- 10,18 ----
  
   <para>
    The <application>spi</application> module provides several workable examples
!   of using the <link linkend="spi">Server Programming Interface</link>
!   (<acronym>SPI</acronym>) and triggers.  While these functions are of
!   some value in
    their own right, they are even more useful as examples to modify for
    your own purposes.  The functions are general enough to be used
    with any table, but you have to specify table and field names (as described
diff --git a/doc/src/sgml/spi.sgml b/doc/src/sgml/spi.sgml
new file mode 100644
index 1044892..0bac342
*** a/doc/src/sgml/spi.sgml
--- b/doc/src/sgml/spi.sgml
***************
*** 42,49 ****
    have documented error-return conventions.  Those conventions only apply
    for errors detected within the SPI functions themselves, however.)
    It is possible to recover control after an error by establishing your own
!   subtransaction surrounding SPI calls that might fail.  This is not currently
!   documented because the mechanisms required are still in flux.
   </para>
  
   <para>
--- 42,48 ----
    have documented error-return conventions.  Those conventions only apply
    for errors detected within the SPI functions themselves, however.)
    It is possible to recover control after an error by establishing your own
!   subtransaction surrounding SPI calls that might fail.
   </para>
  
   <para>


^ permalink  raw  reply  [nested|flat] 11+ messages in thread

* Re: SPI not defined.
@ 2018-01-31 21:55  Bruce Momjian <[email protected]>
  parent: Bruce Momjian <[email protected]>
  0 siblings, 0 replies; 11+ messages in thread

From: Bruce Momjian @ 2018-01-31 21:55 UTC (permalink / raw)
  To: David G. Johnston <[email protected]>; +Cc: Tom Lane <[email protected]>; [email protected] <[email protected]>; [email protected] <[email protected]>

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 <[email protected]> wrote:
> > 
> >     On Mon, Jan 29, 2018 at 10:51:59PM -0500, Tom Lane wrote:
> >     > Bruce Momjian <[email protected]> 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  <[email protected]>        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 +





^ permalink  raw  reply  [nested|flat] 11+ messages in thread


end of thread, other threads:[~2018-01-31 21:55 UTC | newest]

Thread overview: 11+ messages (download: mbox mbox.gz follow: Atom feed)
-- links below jump to the message on this page --
2018-01-29 21:52 SPI not defined. PG Doc comments form <[email protected]>
2018-01-29 22:07 ` David G. Johnston <[email protected]>
2018-01-30 03:26   ` Bruce Momjian <[email protected]>
2018-01-30 03:39     ` David G. Johnston <[email protected]>
2018-01-30 03:54       ` Bruce Momjian <[email protected]>
2018-01-30 03:58         ` Tom Lane <[email protected]>
2018-01-30 03:51     ` Tom Lane <[email protected]>
2018-01-30 03:55       ` Bruce Momjian <[email protected]>
2018-01-30 03:58         ` David G. Johnston <[email protected]>
2018-01-30 04:03           ` Bruce Momjian <[email protected]>
2018-01-31 21:55             ` Bruce Momjian <[email protected]>

This inbox is served by agora; see mirroring instructions
for how to clone and mirror all data and code used for this inbox