Skip to content

Commit 84317b0

Browse files
committed
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
1 parent 6079e5d commit 84317b0

File tree

2 files changed

+6
-5
lines changed

2 files changed

+6
-5
lines changed

doc/src/sgml/pageinspect.sgml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,12 @@
2525
<listitem>
2626
<para>
2727
<function>get_raw_page</function> reads the specified block of the named
28-
table and returns a copy as a <type>bytea</> value. This allows a
28+
relation and returns a copy as a <type>bytea</> value. This allows a
2929
single time-consistent copy of the block to be obtained.
3030
<replaceable>fork</replaceable> should be <literal>'main'</literal> for
31-
the main data fork, or <literal>'fsm'</literal> for the free space map,
32-
or <literal>'vm'</literal> for the visibility map.
31+
the main data fork, <literal>'fsm'</literal> for the free space map,
32+
<literal>'vm'</literal> for the visibility map, or <literal>'init'</literal>
33+
for the initialization fork.
3334
</para>
3435
</listitem>
3536
</varlistentry>

doc/src/sgml/storage.sgml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -237,8 +237,8 @@ The <function>pg_relation_filepath()</> function shows the entire path
237237
as a substitute for remembering many of the above rules. But keep in
238238
mind that this function just gives the name of the first segment of the
239239
main fork of the relation &mdash; you may need to append a segment number
240-
and/or <literal>_fsm</> or <literal>_vm</> to find all the files associated
241-
with the relation.
240+
and/or <literal>_fsm</>, <literal>_vm</>, or <literal>_init</> to find all
241+
the files associated with the relation.
242242
</para>
243243

244244
<para>

0 commit comments

Comments
 (0)