Re: pg_checksums docs mentioning online functions - Mailing list pgsql-docs

From Daniel Gustafsson
Subject Re: pg_checksums docs mentioning online functions
Date
Msg-id 3E59EA84-E150-468A-A316-FC99A009D235@yesql.se
Whole thread
In response to pg_checksums docs mentioning online functions  (Bruce Momjian <bruce@momjian.us>)
Responses Re: pg_checksums docs mentioning online functions
List 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




pgsql-docs by date:

Previous
From: Bruce Momjian
Date:
Subject: pg_checksums docs mentioning online functions
Next
From: Bruce Momjian
Date:
Subject: Re: pg_checksums docs mentioning online functions