postgres.git / summary / log / commit / refs

commit    79b0bc1e9530c05dbeb5c91232faf3ee184439f3
Author:   Fujii Masao <fujii@postgresql.org>
Date:     Mon Aug 11 13:52:16 2014 +0000
First released in: 9.5.0, 9.1.15, 9.2.10, 9.3.6, 9.4.0

    Fix documentation oversights about pageinspect and initialization fork.
    
    The initialization fork was added in 9.1, but has not been taken into
    consideration in documents of get_raw_page function in pageinspect and
    storage layout. This commit fixes those oversights.
    
    get_raw_page can read not only a table but also an index, etc. So it
    should be documented that the function can read any relation. This commit
    also fixes the document of pageinspect that way.
    
    Back-patch to 9.1 where those oversights existed.
    
    Vik Fearing, review by MauMau


 doc/src/sgml/pageinspect.sgml | 7 ++++---
 doc/src/sgml/storage.sgml     | 4 ++--
 2 files changed, 6 insertions(+), 5 deletions(-)

diff --git a/doc/src/sgml/pageinspect.sgml b/doc/src/sgml/pageinspect.sgml
index f4138558b25..3572bec540a 100644
--- a/doc/src/sgml/pageinspect.sgml
+++ b/doc/src/sgml/pageinspect.sgml
@@ -28,11 +28,12 @@
     <listitem>
      <para>
       <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
+      relation and returns a copy as a <type>bytea</> value.  This allows a
       single time-consistent copy of the block to be obtained.
       <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.
+      the main data fork, <literal>'fsm'</literal> for the free space map,
+      <literal>'vm'</literal> for the visibility map, or <literal>'init'</literal>
+      for the initialization fork.
      </para>
     </listitem>
    </varlistentry>
diff --git a/doc/src/sgml/storage.sgml b/doc/src/sgml/storage.sgml
index 1035f58a9b1..8d9610e7040 100644
--- a/doc/src/sgml/storage.sgml
+++ b/doc/src/sgml/storage.sgml
@@ -244,8 +244,8 @@ The <function>pg_relation_filepath()</> function shows the entire path
 as a substitute for remembering many of the above rules.  But keep in
 mind that this function just gives the name of the first segment of the
 main fork of the relation &mdash; you may need to append a segment number
-and/or <literal>_fsm</> or <literal>_vm</> to find all the files associated
-with the relation.
+and/or <literal>_fsm</>, <literal>_vm</>, or <literal>_init</> to find all
+the files associated with the relation.
 </para>
 
 <para>


[parent: d4b13fab4e00]