summaryrefslogtreecommitdiff
path: root/doc/src
diff options
context:
space:
mode:
authorTom Lane <tgl@sss.pgh.pa.us>2009-06-08 16:22:44 +0000
committerTom Lane <tgl@sss.pgh.pa.us>2009-06-08 16:22:44 +0000
commita1fd650d2be769cdc0b163177b938e07ddad8ddb (patch)
tree7a3e59feb5015ca5606021ed054cf2005fa218a2 /doc/src
parent506183e485732e0e76cedb8db0e9ef514c34cba8 (diff)
Fix contrib/pageinspect to not create an ABI breakage between 8.3 and 8.4.
The original implementation of the 3-argument form of get_raw_page() risked core dumps if the 8.3 SQL function definition was mistakenly used with the 8.4 module, which is entirely likely after a dump-and-reload upgrade. To protect 8.4 beta testers against upgrade problems, add a check on PG_NARGS. In passing, fix missed additions to the uninstall script, and polish the docs a trifle.
Diffstat (limited to 'doc/src')
-rw-r--r--doc/src/sgml/pageinspect.sgml12
1 files changed, 7 insertions, 5 deletions
diff --git a/doc/src/sgml/pageinspect.sgml b/doc/src/sgml/pageinspect.sgml
index e510d202aa4..a81989a2a35 100644
--- a/doc/src/sgml/pageinspect.sgml
+++ b/doc/src/sgml/pageinspect.sgml
@@ -1,4 +1,4 @@
-<!-- $PostgreSQL: pgsql/doc/src/sgml/pageinspect.sgml,v 1.5 2008/10/06 14:13:17 heikki Exp $ -->
+<!-- $PostgreSQL: pgsql/doc/src/sgml/pageinspect.sgml,v 1.6 2009/06/08 16:22:44 tgl Exp $ -->
<sect1 id="pageinspect">
<title>pageinspect</title>
@@ -27,8 +27,9 @@
<function>get_raw_page</function> reads the specified block of the named
table and returns a copy as a <type>bytea</> value. This allows a
single time-consistent copy of the block to be obtained.
- <literal>fork</literal> should be <literal>'main'</literal> for the main
- data fork, or <literal>'fsm'</literal> for the FSM.
+ <replaceable>fork</replaceable> should be <literal>'main'</literal> for
+ the main data fork, or <literal>'fsm'</literal> for the free space map,
+ or <literal>'vm'</literal> for the visibility map.
</para>
</listitem>
</varlistentry>
@@ -40,8 +41,9 @@
<listitem>
<para>
- A shorthand of above, for reading from the main fork. Equal to
- <literal>get_raw_page(relname, 0, blkno)</literal>
+ A shorthand version of <function>get_raw_page</function>, for reading
+ from the main fork. Equivalent to
+ <literal>get_raw_page(relname, 'main', blkno)</literal>
</para>
</listitem>
</varlistentry>