Skip to content

Commit 53f32ea

Browse files
committed
doc: Move wal_init_zero and wal_recycle descriptions to proper section.
The group of wal_init_zero and wal_recycle is WAL_SETTINGS in guc.c, but previously their documents were located in "Replication"/"Sending Servers" section. This commit moves them to the proper section "Write Ahead Log"/"Settings". Back-patch to v12 where wal_init_zero and wal_recycle parameters were introduced. Author: Fujii Masao Discussion: https://postgr.es/m/b5190ab4-a169-6a42-0e49-aed0807c8976@oss.nttdata.com
1 parent 894041e commit 53f32ea

File tree

1 file changed

+35
-35
lines changed

1 file changed

+35
-35
lines changed

doc/src/sgml/config.sgml

Lines changed: 35 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -2783,6 +2783,41 @@ include_dir 'conf.d'
27832783
</listitem>
27842784
</varlistentry>
27852785

2786+
<varlistentry id="guc-wal-init-zero" xreflabel="wal_init_zero">
2787+
<term><varname>wal_init_zero</varname> (<type>boolean</type>)
2788+
<indexterm>
2789+
<primary><varname>wal_init_zero</varname> configuration parameter</primary>
2790+
</indexterm>
2791+
</term>
2792+
<listitem>
2793+
<para>
2794+
If set to <literal>on</literal> (the default), this option causes new
2795+
WAL files to be filled with zeroes. On some file systems, this ensures
2796+
that space is allocated before we need to write WAL records. However,
2797+
<firstterm>Copy-On-Write</firstterm> (COW) file systems may not benefit
2798+
from this technique, so the option is given to skip the unnecessary
2799+
work. If set to <literal>off</literal>, only the final byte is written
2800+
when the file is created so that it has the expected size.
2801+
</para>
2802+
</listitem>
2803+
</varlistentry>
2804+
2805+
<varlistentry id="guc-wal-recycle" xreflabel="wal_recycle">
2806+
<term><varname>wal_recycle</varname> (<type>boolean</type>)
2807+
<indexterm>
2808+
<primary><varname>wal_recycle</varname> configuration parameter</primary>
2809+
</indexterm>
2810+
</term>
2811+
<listitem>
2812+
<para>
2813+
If set to <literal>on</literal> (the default), this option causes WAL
2814+
files to be recycled by renaming them, avoiding the need to create new
2815+
ones. On COW file systems, it may be faster to create new ones, so the
2816+
option is given to disable this behavior.
2817+
</para>
2818+
</listitem>
2819+
</varlistentry>
2820+
27862821
<varlistentry id="guc-wal-buffers" xreflabel="wal_buffers">
27872822
<term><varname>wal_buffers</varname> (<type>integer</type>)
27882823
<indexterm>
@@ -3686,41 +3721,6 @@ restore_command = 'copy "C:\\server\\archivedir\\%f" "%p"' # Windows
36863721
</listitem>
36873722
</varlistentry>
36883723

3689-
<varlistentry id="guc-wal-init-zero" xreflabel="wal_init_zero">
3690-
<term><varname>wal_init_zero</varname> (<type>boolean</type>)
3691-
<indexterm>
3692-
<primary><varname>wal_init_zero</varname> configuration parameter</primary>
3693-
</indexterm>
3694-
</term>
3695-
<listitem>
3696-
<para>
3697-
If set to <literal>on</literal> (the default), this option causes new
3698-
WAL files to be filled with zeroes. On some file systems, this ensures
3699-
that space is allocated before we need to write WAL records. However,
3700-
<firstterm>Copy-On-Write</firstterm> (COW) file systems may not benefit
3701-
from this technique, so the option is given to skip the unnecessary
3702-
work. If set to <literal>off</literal>, only the final byte is written
3703-
when the file is created so that it has the expected size.
3704-
</para>
3705-
</listitem>
3706-
</varlistentry>
3707-
3708-
<varlistentry id="guc-wal-recycle" xreflabel="wal_recycle">
3709-
<term><varname>wal_recycle</varname> (<type>boolean</type>)
3710-
<indexterm>
3711-
<primary><varname>wal_recycle</varname> configuration parameter</primary>
3712-
</indexterm>
3713-
</term>
3714-
<listitem>
3715-
<para>
3716-
If set to <literal>on</literal> (the default), this option causes WAL
3717-
files to be recycled by renaming them, avoiding the need to create new
3718-
ones. On COW file systems, it may be faster to create new ones, so the
3719-
option is given to disable this behavior.
3720-
</para>
3721-
</listitem>
3722-
</varlistentry>
3723-
37243724
<varlistentry id="guc-wal-sender-timeout" xreflabel="wal_sender_timeout">
37253725
<term><varname>wal_sender_timeout</varname> (<type>integer</type>)
37263726
<indexterm>

0 commit comments

Comments
 (0)