Fix manpages related to SPI functions.

This patch adds declaration so that they end up in section 3, and adds
them to the Makefiles to install them.

Also, some synopses needed reflowing so that they look nice in 80-column
terminals.

diff --git a/doc/Makefile b/doc/Makefile
index 247b04752cd6e3025789d7642ab83f646931c9ec..27274bff8fa0da7bc0e073405b3106491084e09b 100644 (file)
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -4,7 +4,7 @@
 #
 # Copyright (c) 1994, Regents of the University of California
 #
-# $PostgreSQL: pgsql/doc/Makefile,v 1.37 2009/06/27 21:06:46 tgl Exp $
+# $PostgreSQL: pgsql/doc/Makefile,v 1.38 2009/08/05 19:31:49 alvherre Exp $
 #
 #----------------------------------------------------------------------------
 
@@ -47,9 +47,9 @@ fix_sqlmansectnum = sed -e '/^\.TH/s/"7"/"$(sqlmansect)"/' \
            -e 's/\\fR(7)/\\fR($(sqlmansectnum))/g' \
            -e '1s/^\.so man7/.so man$(sqlmansectnum)/g;1s/^\(\.so.*\)\.7$$/\1.$(sqlmansect)/g'
 
-all: man1/.timestamp man$(sqlmansectnum)/.timestamp
+all: man1/.timestamp man3/.timestamp man$(sqlmansectnum)/.timestamp
 
-man1/.timestamp: man7/.timestamp
+man1/.timestamp man3/.timestamp: man7/.timestamp
    @echo timestamp >$@
 
 man7/.timestamp: man.tar.gz
@@ -79,7 +79,7 @@ ifdef found_html
    gzip -d -c $(srcdir)/postgres.tar.gz | ( cd $(DESTDIR)$(htmldir)/html && $(TAR) xf - )
 endif
 ifdef found_man
-   for file in man1/*.1 man$(sqlmansectnum)/*.$(sqlmansect) ; do \
+   for file in man1/*.1 man3/*.3 man$(sqlmansectnum)/*.$(sqlmansect) ; do \
      $(INSTALL_DATA) $$file $(DESTDIR)$(mandir)/$$file || exit; \
    done
 endif
@@ -90,7 +90,7 @@ ifdef found_html
    $(mkinstalldirs) '$(DESTDIR)$(htmldir)'/html
 endif
 ifdef found_man
-   $(mkinstalldirs) $(addprefix '$(DESTDIR)$(mandir)'/man, 1 $(sqlmansectnum))
+   $(mkinstalldirs) $(addprefix '$(DESTDIR)$(mandir)'/man, 1 3 $(sqlmansectnum))
 endif
 
 
@@ -104,5 +104,5 @@ endif
 
 
 clean distclean maintainer-clean:
-   rm -rf man1/ man7/ man$(sqlmansectnum)/
+   rm -rf man1/ man3/ man7/ man$(sqlmansectnum)/
    $(MAKE) -C src $@

diff --git a/doc/src/Makefile b/doc/src/Makefile
index 5d9f75f07fc99e53affb437dfd657a6067d60733..23670764a2d7c4bfcd08a66a8a2f22e7dcc63464 100644 (file)
--- a/doc/src/Makefile
+++ b/doc/src/Makefile
@@ -1,5 +1,5 @@
 # Postgres documentation makefile
-# $PostgreSQL: pgsql/doc/src/Makefile,v 1.35 2008/11/14 10:43:59 petere Exp $
+# $PostgreSQL: pgsql/doc/src/Makefile,v 1.36 2009/08/05 19:31:50 alvherre Exp $
 
 subdir = doc/src
 top_builddir = ../..
@@ -15,4 +15,4 @@ postgres.tar:
 
 man.tar:
    $(MAKE) -C sgml man
-   $(TAR) -cf $@ -C sgml man1 man7
+   $(TAR) -cf $@ -C sgml man1 man3 man7

diff --git a/doc/src/sgml/Makefile b/doc/src/sgml/Makefile
index 33bd247629e722b6652cdf999badb94337c25e01..09951ec3d9173d956d58c47a8962f21f15fb4f2f 100644 (file)
--- a/doc/src/sgml/Makefile
+++ b/doc/src/sgml/Makefile
@@ -2,7 +2,7 @@
 #
 # PostgreSQL documentation makefile
 #
-# $PostgreSQL: pgsql/doc/src/sgml/Makefile,v 1.120 2009/08/04 22:04:37 petere Exp $
+# $PostgreSQL: pgsql/doc/src/sgml/Makefile,v 1.121 2009/08/05 19:31:50 alvherre Exp $
 #
 #----------------------------------------------------------------------------
 
@@ -74,7 +74,7 @@ man: man-stamp
 
 man-stamp: stylesheet-man.xsl postgres.xml
    $(XSLTPROC) $(XSLTPROCFLAGS) $^
-   rm man1/SPI* man1/dblink*
+   rm man1/dblink*
    touch $@
 
 
@@ -269,7 +269,7 @@ clean distclean maintainer-clean:
 # HTML
    rm -f *.html html-stamp
 # man
-   rm -rf man1 man7 man-stamp
+   rm -rf man1 man3 man7 man-stamp
 # print
    rm -f *.rtf *.tex-ps *.tex-pdf *.dvi *.aux *.log *.ps *.pdf *.out *.fot
 # index

diff --git a/doc/src/sgml/spi.sgml b/doc/src/sgml/spi.sgml
index 32cc6149f987c0a40c732f8ca6f64adcb41b0ede..07fab82badcec38b30bfd45e877ba3ca9e29972e 100644 (file)
--- a/doc/src/sgml/spi.sgml
+++ b/doc/src/sgml/spi.sgml
@@ -1,4 +1,4 @@
-
+
 
 
  Server Programming Interface
@@ -65,6 +65,7 @@
  
   
    SPI_connect
+   3
   
 
   
@@ -136,6 +137,7 @@ int SPI_connect(void)
 
  
   SPI_finish
+  3
  
 
  
@@ -201,6 +203,7 @@ int SPI_finish(void)
 
  
   SPI_push
+  3
  
 
  
@@ -248,6 +251,7 @@ void SPI_push(void)
 
  
   SPI_pop
+  3
  
 
  
@@ -279,6 +283,7 @@ void SPI_pop(void)
 
  
   SPI_execute
+  3
  
 
  
@@ -625,6 +630,7 @@ typedef struct
 
  
   SPI_exec
+  3
  
 
  
@@ -689,6 +695,7 @@ int SPI_exec(const char * command, long count<
 
  
   SPI_execute_with_args
+  3
  
 
  
@@ -833,6 +840,7 @@ int SPI_execute_with_args(const char *command,
 
  
   SPI_prepare
+  3
  
 
  
@@ -956,6 +964,7 @@ SPIPlanPtr SPI_prepare(const char * command, int 
 
  
   SPI_prepare_cursor
+  3
  
 
  
@@ -967,7 +976,8 @@ SPIPlanPtr SPI_prepare(const char * command, int 
 
  
 
-SPIPlanPtr SPI_prepare_cursor(const char * command, int nargs, Oid * argtypes, int cursorOptions)
+SPIPlanPtr SPI_prepare_cursor(const char * command, int nargs,
+                              Oid * argtypes, int cursorOptions)
 
  
 
@@ -1054,6 +1064,7 @@ SPIPlanPtr SPI_prepare_cursor(const char * command, int <
 
  
   SPI_getargcount
+  3
  
 
  
@@ -1110,6 +1121,7 @@ int SPI_getargcount(SPIPlanPtr plan)
 
  
   SPI_getargtypeid
+  3
  
 
  
@@ -1179,6 +1191,7 @@ Oid SPI_getargtypeid(SPIPlanPtr plan, int argI
 
  
   SPI_is_cursor_plan
+  3
  
 
  
@@ -1247,6 +1260,7 @@ bool SPI_is_cursor_plan(SPIPlanPtr plan)
 
  
   SPI_execute_plan
+  3
  
 
  
@@ -1389,6 +1403,7 @@ int SPI_execute_plan(SPIPlanPtr plan, Datum * 
 
  
   SPI_execp
+  3
  
 
  
@@ -1488,6 +1503,7 @@ int SPI_execp(SPIPlanPtr plan, Datum * values<
 
  
   SPI_cursor_open
+  3
  
 
  
@@ -1610,6 +1626,7 @@ Portal SPI_cursor_open(const char * name, SPIPlanPtr 
 
  
   SPI_cursor_open_with_args
+  3
  
 
  
@@ -1756,6 +1773,7 @@ Portal SPI_cursor_open_with_args(const char *name,
 
  
   SPI_cursor_find
+  3
  
 
  
@@ -1811,6 +1829,7 @@ Portal SPI_cursor_find(const char * name)
 
  
   SPI_cursor_fetch
+  3
  
 
  
@@ -1895,6 +1914,7 @@ void SPI_cursor_fetch(Portal portal, bool forw
 
  
   SPI_cursor_move
+  3
  
 
  
@@ -1969,6 +1989,7 @@ void SPI_cursor_move(Portal portal, bool forwa
 
  
   SPI_scroll_cursor_fetch
+  3
  
 
  
@@ -1980,7 +2001,8 @@ void SPI_cursor_move(Portal portal, bool forwa
 
  
 
-void SPI_scroll_cursor_fetch(Portal portal, FetchDirection direction, long count)
+void SPI_scroll_cursor_fetch(Portal portal, FetchDirection direction,
+                             long count)
 
  
 
@@ -2066,6 +2088,7 @@ void SPI_scroll_cursor_fetch(Portal portal, FetchDirectio
 
  
   SPI_scroll_cursor_move
+  3
  
 
  
@@ -2077,7 +2100,8 @@ void SPI_scroll_cursor_fetch(Portal portal, FetchDirectio
 
  
 
-void SPI_scroll_cursor_move(Portal portal, FetchDirection direction, long count)
+void SPI_scroll_cursor_move(Portal portal, FetchDirection direction,
+                            long count)
 
  
 
@@ -2165,6 +2189,7 @@ void SPI_scroll_cursor_move(Portal portal, FetchDirection
 
  
   SPI_cursor_close
+  3
  
 
  
@@ -2216,6 +2241,7 @@ void SPI_cursor_close(Portal portal)
 
  
   SPI_saveplan
+  3
  
 
  
@@ -2327,6 +2353,7 @@ SPIPlanPtr SPI_saveplan(SPIPlanPtr plan)
 
  
   SPI_fname
+  3
  
 
  
@@ -2393,6 +2420,7 @@ char * SPI_fname(TupleDesc rowdesc, int colnum
 
  
   SPI_fnumber
+  3
  
 
  
@@ -2466,6 +2494,7 @@ int SPI_fnumber(TupleDesc rowdesc, const char * 
 
  
   SPI_getvalue
+  3
  
 
  
@@ -2549,6 +2578,7 @@ char * SPI_getvalue(HeapTuple row, TupleDesc r
 
  
   SPI_getbinval
+  3
  
 
  
@@ -2560,7 +2590,8 @@ char * SPI_getvalue(HeapTuple row, TupleDesc r
 
  
 
-Datum SPI_getbinval(HeapTuple row, TupleDesc rowdesc, int colnumber, bool * isnull)
+Datum SPI_getbinval(HeapTuple row, TupleDesc rowdesc, int colnumber,
+                    bool * isnull)
 
  
 
@@ -2642,6 +2673,7 @@ Datum SPI_getbinval(HeapTuple row, TupleDesc r
 
  
   SPI_gettype
+  3
  
 
  
@@ -2707,6 +2739,7 @@ char * SPI_gettype(TupleDesc rowdesc, int coln
 
  
   SPI_gettypeid
+  3
  
 
  
@@ -2772,6 +2805,7 @@ Oid SPI_gettypeid(TupleDesc rowdesc, int colnu
 
  
   SPI_getrelname
+  3
  
 
  
@@ -2824,6 +2858,7 @@ char * SPI_getrelname(Relation rel)
 
  
   SPI_getnspname
+  3
  
 
  
@@ -2955,6 +2990,7 @@ char * SPI_getnspname(Relation rel)
 
  
   SPI_palloc
+  3
  
 
  
@@ -3008,6 +3044,7 @@ void * SPI_palloc(Size size)
 
  
   SPI_repalloc
+  3
  
 
  
@@ -3077,6 +3114,7 @@ void * SPI_repalloc(void * pointer, Size size<
 
  
   SPI_pfree
+  3
  
 
  
@@ -3129,6 +3167,7 @@ void SPI_pfree(void * pointer)
 
  
   SPI_copytuple
+  3
  
 
  
@@ -3185,6 +3224,7 @@ HeapTuple SPI_copytuple(HeapTuple row)
 
  
   SPI_returntuple
+  3
  
 
  
@@ -3259,6 +3299,7 @@ HeapTupleHeader SPI_returntuple(HeapTuple row, TupleDesc
 
  
   SPI_modifytuple
+  3
  
 
  
@@ -3270,7 +3311,8 @@ HeapTupleHeader SPI_returntuple(HeapTuple row, TupleDesc
 
  
 
-HeapTuple SPI_modifytuple(Relation rel, HeapTuple row, ncols, colnum, Datum * values, const char * nulls)
+HeapTuple SPI_modifytuple(Relation rel, HeapTuple row, int ncols,
+                          int * colnum, Datum * values, const char * nulls)
 
  
 
@@ -3393,6 +3435,7 @@ HeapTuple SPI_modifytuple(Relation rel, HeapTuple 
 
  
   SPI_freetuple
+  3
  
 
  
@@ -3444,6 +3487,7 @@ void SPI_freetuple(HeapTuple row)
 
  
   SPI_freetuptable
+  3
  
 
  
@@ -3500,6 +3544,7 @@ void SPI_freetuptable(SPITupleTable * tuptable)
 
  
   SPI_freeplan
+  3