From 84317b072021250c78cd1e127913f5d0a30e9028 Mon Sep 17 00:00:00 2001
From: Fujii Masao <fujii@postgresql.org>
Date: Mon, 11 Aug 2014 22:52:16 +0900
Subject: [PATCH] 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 acbb05bc9c5..f95eaa8b508 100644
--- a/doc/src/sgml/pageinspect.sgml
+++ b/doc/src/sgml/pageinspect.sgml
@@ -25,11 +25,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 bd2dca39fcb..30f5e480578 100644
--- a/doc/src/sgml/storage.sgml
+++ b/doc/src/sgml/storage.sgml
@@ -237,8 +237,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 — 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>
--
GitLab