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: Documentation updates for online checksums
Date: Mon, 14 Sep 2026 13:34:14 +0000
Message-ID: <E1x66p4-00000000I6P-2cTb@gemulon.postgresql.org> (raw)

doc: Documentation updates for online checksums

A set of documentation updates for the online checksums work, found via
manual as well as LLM-guided review.

  * The state diagram was re-done to be improve readability and be
    more in line with the look and feel of other diagrams.
  * Paragraph about mismatched states moved to its own sect2.
  * The documentation for the functions to enable/ disable checksums
    failed to mention that they are superuser only.
  * The documentation for the checksums progress reporting had
    accidentally omitted the work "fork" and for the blocks_* columns.
    The values are per fork but the documentation made it seem they
    were per relation.
  * Add the state image to the meson buildfile

Reported-by: Heikki Linnakangas <hlinnaka@iki.fi>
Reported-by: Noah Misch <noah@leadboat.com>
Discussion: https://postgr.es/m/5b08b4d1-0982-4b77-bac5-3bdffc6583f5@iki.fi
Backpatch-through: 19

Branch
------
master

Details
-------
https://git.postgresql.org/pg/commitdiff/2bd7519a8150e7607c7ea8a89067bd0888526ddb

Modified Files
--------------
doc/src/sgml/func/func-admin.sgml     |  13 ++-
doc/src/sgml/images/datachecksums.gv  |  61 ++++++++++---
doc/src/sgml/images/datachecksums.svg | 163 ++++++++++++++++++++++------------
doc/src/sgml/images/meson.build       |   1 +
doc/src/sgml/monitoring.sgml          |   4 +-
doc/src/sgml/ref/pg_checksums.sgml    |   2 +-
doc/src/sgml/wal.sgml                 |  62 +++++++------
7 files changed, 204 insertions(+), 102 deletions(-)



Message-ID: <E1x66p4-00000000I6P-2cTb@gemulon.postgresql.org>
Permalink:  ../E1x66p4-00000000I6P-2cTb@gemulon.postgresql.org/
Also on:    postgresql.org/message-id/E1x66p4-00000000I6P-2cTb@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: Documentation updates for online checksums
  In-Reply-To: <E1x66p4-00000000I6P-2cTb@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