1
0
mirror of https://github.com/postgres/postgres.git synced 2026-10-23 13:29:09 +03:00

doc: Fix link text for data checksums

Commit 67846550dc removed the xreflabels for initdb options, which
turned the sentence "The second field contains the page checksum if
data checksums are enabled" into "The second field contains the page
checksum if -k are enabled", as well "Only has effect if data checksums
are enabled" into "Only has effect if -k are enabled".

Fix by setting an explicit link text, and while there also change the
link to point to the data checksum page which has more information
than just the initdb option.

The original report was for one instance, further inspection turned
up quite a few more cases.  Also redirect the link in the amcheck
docs which albeit was reading right, but will be more helpful if
linking to the main page on data checksums.  Backpatch to v18 where
the xreflabels were removed.

Author: Daniel Gustafsson <daniel@yesql.se>
Reported-by: y.saburov@gmail.com
Reviewed-by: Laurenz Albe <laurenz.albe@cybertec.at>
Discussion: https://postgr.es/m/178350739237.73862.4549076173872335741@wrigleys.postgresql.org
Backpatch-through: 18
This commit is contained in:
Daniel Gustafsson
2026-07-16 16:05:36 +02:00
parent 0231fa2c3a
commit e3a27cad46
3 changed files with 4 additions and 5 deletions

View File

@@ -421,9 +421,8 @@ SET client_min_messages = DEBUG1;
<para>
<filename>amcheck</filename> can be effective at detecting various types of
failure modes that <link
linkend="app-initdb-data-checksums"><application>data
checksums</application></link> will fail to catch. These include:
failure modes that <link linkend="checksums">data checksums</link> will fail
to catch. These include:
<itemizedlist>
<listitem>

View File

@@ -13183,7 +13183,7 @@ LOG: CleanUpLock: deleting: lock(0xb7acd844) id(24688,24696,0,0,0,1)
</term>
<listitem>
<para>
Only has effect if <xref linkend="app-initdb-data-checksums"/> are enabled.
Only has effect if <link linkend="checksums">data checksums</link> are enabled.
</para>
<para>
Detection of a checksum failure during a read normally causes

View File

@@ -797,7 +797,7 @@ data. Empty in ordinary tables.</entry>
(<structname>PageHeaderData</structname>). Its format is detailed in <xref
linkend="pageheaderdata-table"/>. The first field tracks the most
recent WAL entry related to this page. The second field contains
the page checksum if <xref linkend="app-initdb-data-checksums"/> are
the page checksum if <link linkend="checksums">data checksums</link> are
enabled. Next is a 2-byte field containing flag bits. This is followed
by three 2-byte integer fields (<structfield>pd_lower</structfield>,
<structfield>pd_upper</structfield>, and