Fix documentation oversights about pageinspect and initialization fork.
authorFujii Masao
Mon, 11 Aug 2014 13:52:16 +0000 (22:52 +0900)
committerFujii Masao
Mon, 11 Aug 2014 13:53:05 +0000 (22:53 +0900)
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
doc/src/sgml/storage.sgml

index f4138558b25c9b25b29c40813ac95904981cf07e..3572bec540a07ef18120f4ba349fdd51990170da 100644 (file)
     
      
       get_raw_page reads the specified block of the named
-      table and returns a copy as a bytea value.  This allows a
+      relation and returns a copy as a bytea value.  This allows a
       single time-consistent copy of the block to be obtained.
       fork should be 'main' for
-      the main data fork, or 'fsm' for the free space map,
-      or 'vm' for the visibility map.
+      the main data fork, 'fsm' for the free space map,
+      'vm' for the visibility map, or 'init'
+      for the initialization fork.
      
     
    
index 1035f58a9b1554d9367f277848078009b67d5a5f..8d9610e7040048bf0d7da81f8d4d313d7be30f90 100644 (file)
@@ -244,8 +244,8 @@ The 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 — you may need to append a segment number
-and/or _fsm or _vm to find all the files associated
-with the relation.
+and/or _fsm_vm, or _init to find all
+the files associated with the relation.