Skip to content

Commit 901a1cf

Browse files
committed
doc: clarify default checksum behavior in non-master branches
Also simplify and correct data checksum wording in master now that it is the default. PG 13 did not have the awkward wording. Reported-by: Felix <afripowered@gmail.com> Reviewed-by: Laurenz Albe Discussion: https://postgr.es/m/173928241056.707.3989867022954178032@wrigleys.postgresql.org Backpatch-through: 14
1 parent 6ea0734 commit 901a1cf

File tree

4 files changed

+12
-14
lines changed

4 files changed

+12
-14
lines changed

doc/src/sgml/amcheck.sgml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -466,8 +466,8 @@ SET client_min_messages = DEBUG1;
466466
</listitem>
467467
<listitem>
468468
<para>
469-
File system or storage subsystem faults where checksums happen to
470-
simply not be enabled.
469+
File system or storage subsystem faults when data checksums are
470+
disabled.
471471
</para>
472472
<para>
473473
Note that <filename>amcheck</filename> examines a page as represented in some

doc/src/sgml/monitoring.sgml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3532,8 +3532,8 @@ description | Waiting for a newly initialized WAL file to reach durable storage
35323532
</para>
35333533
<para>
35343534
Number of data page checksum failures detected in this
3535-
database (or on a shared object), or NULL if data checksums are not
3536-
enabled.
3535+
database (or on a shared object), or NULL if data checksums are
3536+
disabled.
35373537
</para></entry>
35383538
</row>
35393539

@@ -3543,8 +3543,8 @@ description | Waiting for a newly initialized WAL file to reach durable storage
35433543
</para>
35443544
<para>
35453545
Time at which the last data page checksum failure was detected in
3546-
this database (or on a shared object), or NULL if data checksums are not
3547-
enabled.
3546+
this database (or on a shared object), or NULL if data checksums are
3547+
disabled.
35483548
</para></entry>
35493549
</row>
35503550

doc/src/sgml/pageinspect.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ test=# SELECT * FROM page_header(get_raw_page('pg_class', 0));
8585
<para>
8686
The <structfield>checksum</structfield> field is the checksum stored in
8787
the page, which might be incorrect if the page is somehow corrupted. If
88-
data checksums are not enabled for this instance, then the value stored
88+
data checksums are disabled for this instance, then the value stored
8989
is meaningless.
9090
</para>
9191
</listitem>

doc/src/sgml/wal.sgml

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -194,10 +194,8 @@
194194
</listitem>
195195
<listitem>
196196
<para>
197-
Data pages are not currently checksummed by default, though full page images
198-
recorded in WAL records will be protected; see <link
199-
linkend="app-initdb-data-checksums"><application>initdb</application></link>
200-
for details about enabling data checksums.
197+
Data pages are checksummed by default, and full page images
198+
recorded in WAL records are always checksum protected.
201199
</para>
202200
</listitem>
203201
<listitem>
@@ -238,15 +236,15 @@
238236
</indexterm>
239237

240238
<para>
241-
By default, data pages are not protected by checksums, but this can
242-
optionally be enabled for a cluster. When enabled, each data page includes
239+
By default, data pages are protected by checksums, but this can
240+
optionally be disabled for a cluster. When enabled, each data page includes
243241
a checksum that is updated when the page is written and verified each time
244242
the page is read. Only data pages are protected by checksums; internal data
245243
structures and temporary files are not.
246244
</para>
247245

248246
<para>
249-
Checksums are normally enabled when the cluster is initialized using <link
247+
Checksums can be disabled when the cluster is initialized using <link
250248
linkend="app-initdb-data-checksums"><application>initdb</application></link>.
251249
They can also be enabled or disabled at a later time as an offline
252250
operation. Data checksums are enabled or disabled at the full cluster

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy