From: Tom Lane <tgl@sss.pgh.pa.us>
Date: Sun, 10 Sep 2006 20:56:42 +0000 (+0000)
Subject: Remove unhelpful/misleading advice about how to use SPI_saveplan().
X-Git-Tag: REL8_2_BETA1~111
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=17c371fe82b7bed48cce4532d9337ccee9cdc009;p=postgresql

Remove unhelpful/misleading advice about how to use SPI_saveplan().
Per gripe from Jack Orenstein.
---

diff --git a/doc/src/sgml/spi.sgml b/doc/src/sgml/spi.sgml
index b19189632e..b8c8855572 100644
--- a/doc/src/sgml/spi.sgml
+++ b/doc/src/sgml/spi.sgml
@@ -1,4 +1,4 @@
-<!-- $PostgreSQL: pgsql/doc/src/sgml/spi.sgml,v 1.47 2006/08/27 23:47:57 tgl Exp $ -->
+<!-- $PostgreSQL: pgsql/doc/src/sgml/spi.sgml,v 1.48 2006/09/10 20:56:42 tgl Exp $ -->
 
 <chapter id="spi">
  <title>Server Programming Interface</title>
@@ -1614,10 +1614,7 @@ void * SPI_saveplan(void * <parameter>plan</parameter>)
    by <function>SPI_finish</function> and by the transaction manager
    and returns a pointer to the saved plan.  This gives you the
    ability to reuse prepared plans in the subsequent invocations of
-   your procedure in the current session.  You may save the pointer
-   returned in a local variable.  Always check if this pointer is
-   <symbol>NULL</symbol> or not either when preparing a plan or using
-   an already prepared plan in <function>SPI_execute_plan</function>.
+   your procedure in the current session.
   </para>
  </refsect1>