postgres.git / summary / log / commit / refs

commit    30c0442eb308cdb9a0d1b8551758775ec4d0e75d
Author:   Daniel Gustafsson <dgustafsson@postgresql.org>
Date:     Thu Jul 16 14:05:36 2026 +0000
First released in: 18.6

    doc: Fix link text for data checksums
    
    Commit 67846550dc6d 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


 doc/src/sgml/amcheck.sgml | 5 ++---
 doc/src/sgml/config.sgml  | 2 +-
 doc/src/sgml/storage.sgml | 2 +-
 3 files changed, 4 insertions(+), 5 deletions(-)

diff --git a/doc/src/sgml/amcheck.sgml b/doc/src/sgml/amcheck.sgml
index 0402172a5ff..747dc115f48 100644
--- a/doc/src/sgml/amcheck.sgml
+++ b/doc/src/sgml/amcheck.sgml
@@ -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>
diff --git a/doc/src/sgml/config.sgml b/doc/src/sgml/config.sgml
index 5b33465cd44..11fcbdee046 100644
--- a/doc/src/sgml/config.sgml
+++ b/doc/src/sgml/config.sgml
@@ -12659,7 +12659,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
diff --git a/doc/src/sgml/storage.sgml b/doc/src/sgml/storage.sgml
index 61250799ec0..245f18c65c9 100644
--- a/doc/src/sgml/storage.sgml
+++ b/doc/src/sgml/storage.sgml
@@ -793,7 +793,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


[parent: a6a2eb9f6024]