agora inbox for pgsql-committers@postgresql.org  
help / color / mirror / Atom feed
pgsql: doc: Fix link text for data checksums
3+ messages / 1 participants
[nested] [flat]

* pgsql: doc: Fix link text for data checksums
@ 2026-07-16 14:13  Daniel Gustafsson <dgustafsson@postgresql.org>
  0 siblings, 0 replies; 3+ messages in thread

From: Daniel Gustafsson @ 2026-07-16 14:13 UTC (permalink / raw)
  To: pgsql-committers@lists.postgresql.org

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
------
master

Details
-------
https://git.postgresql.org/pg/commitdiff/0de346f464b1efd2bfa74fb22c1d6ffe2f733b63

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



^ permalink  raw  reply  [nested|flat] 3+ messages in thread

* pgsql: doc: Fix link text for data checksums
@ 2026-07-16 14:13  Daniel Gustafsson <dgustafsson@postgresql.org>
  0 siblings, 0 replies; 3+ messages in thread

From: Daniel Gustafsson @ 2026-07-16 14:13 UTC (permalink / raw)
  To: pgsql-committers@lists.postgresql.org

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_19_STABLE

Details
-------
https://git.postgresql.org/pg/commitdiff/e3a27cad462f08716312e692b426747d840803c6

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



^ permalink  raw  reply  [nested|flat] 3+ messages in thread

* pgsql: doc: Fix link text for data checksums
@ 2026-07-16 14:14  Daniel Gustafsson <dgustafsson@postgresql.org>
  0 siblings, 0 replies; 3+ messages in thread

From: Daniel Gustafsson @ 2026-07-16 14:14 UTC (permalink / raw)
  To: pgsql-committers@lists.postgresql.org

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



^ permalink  raw  reply  [nested|flat] 3+ messages in thread


end of thread, other threads:[~2026-07-16 14:14 UTC | newest]

Thread overview: 3+ messages (download: mbox mbox.gz follow: Atom feed)
-- links below jump to the message on this page --
2026-07-16 14:13 pgsql: doc: Fix link text for data checksums Daniel Gustafsson <dgustafsson@postgresql.org>
2026-07-16 14:13 pgsql: doc: Fix link text for data checksums Daniel Gustafsson <dgustafsson@postgresql.org>
2026-07-16 14:14 pgsql: doc: Fix link text for data checksums Daniel Gustafsson <dgustafsson@postgresql.org>

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