Re: pg_checksums docs mentioning online functions

Daniel Gustafsson <daniel@yesql.se>

From: Daniel Gustafsson <daniel@yesql.se>
To: Bruce Momjian <bruce@momjian.us>
Cc: PostgreSQL-documentation <pgsql-docs@lists.postgresql.org>
Date: 2026-06-04T19:18:34Z
Lists: pgsql-docs
> On 4 Jun 2026, at 20:55, Bruce Momjian <bruce@momjian.us> wrote:
> 
> Looking at the pg_checksums docs, it says:
> 
> pg_checksums checks, enables or disables data checksums in a
> PostgreSQL cluster. The server must be shut down cleanly before
> running pg_checksums.
> 
> Do we want to mention the new functions here that can change the
> checksum status without being shut down?

Not sure, but perhaps a link back to the main data checksums section (which
documents the online operation among other things) would be in order?
Something like:

--- a/doc/src/sgml/ref/pg_checksums.sgml
+++ b/doc/src/sgml/ref/pg_checksums.sgml
@@ -57,6 +57,10 @@ PostgreSQL documentation
    rewritten in-place.
    Disabling checksums only updates the file <filename>pg_control</filename>.
   </para>
+
+  <para>
+   For more information on data checksums, see <xref linkend="checksums"/>.
+  </para>
  </refsect1>

--
Daniel Gustafsson




Commits

  1. doc: Mention online checksum enabling in pg_checksums docs