agora inbox for pgsql-committers@postgresql.org  
help / color / mirror / Atom feed
From: Daniel Gustafsson <dgustafsson@postgresql.org>
To: pgsql-committers@lists.postgresql.org
Subject: pgsql: doc: Fix link text for data checksums
Date: Thu, 16 Jul 2026 14:14:13 +0000
Message-ID: <E1wkMqr-000TFm-0J@gemulon.postgresql.org> (raw)

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

Branch
------
REL_18_STABLE

Details
-------
https://git.postgresql.org/pg/commitdiff/30c0442eb308cdb9a0d1b8551758775ec4d0e75d

Modified Files
--------------
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(-)



view thread (3+ messages)

Message-ID: <E1wkMqr-000TFm-0J@gemulon.postgresql.org>
Permalink:  ../E1wkMqr-000TFm-0J@gemulon.postgresql.org/
Also on:    postgresql.org/message-id/E1wkMqr-000TFm-0J@gemulon.postgresql.org

reply

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Reply to all the recipients using the --to and --cc options:
  reply via email

  To: pgsql-committers@postgresql.org
  Cc: dgustafsson@postgresql.org, pgsql-committers@lists.postgresql.org
  Subject: Re: pgsql: doc: Fix link text for data checksums
  In-Reply-To: <E1wkMqr-000TFm-0J@gemulon.postgresql.org>

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

This inbox is served by agora; see mirroring instructions
for how to clone and mirror all data and code used for this inbox