postgres.git / summary / log / commit / refs

commit    4ae3e98c02cf57ba5e1d29e914a3b2e4d15f066f
Author:   Daniel Gustafsson <dgustafsson@postgresql.org>
Date:     Thu Jun 04 22:12:33 2026 +0000

    doc:  Mention online checksum enabling in pg_checksums docs
    
    The documentation for bin/pg_checksums refered to online processing only
    in passing, this extends the documentation to list online checksums as as
    alternative as well as providing a link to the new Data Checksums section.
    
    Author: Daniel Gustafsson <daniel@yesql.se>
    Reviewed-by: Bruce Momjian <bruce@momjian.us>
    Reported-by: Bruce Momjian <bruce@momjian.us>
    Discussion: https://postgr.es/m/aiHKJWa1k28fFTqf@momjian.us


 doc/src/sgml/ref/pg_checksums.sgml | 15 ++++++++++-----
 doc/src/sgml/wal.sgml              |  2 +-
 2 files changed, 11 insertions(+), 6 deletions(-)

diff --git a/doc/src/sgml/ref/pg_checksums.sgml b/doc/src/sgml/ref/pg_checksums.sgml
index 45890324075..8a18f447d15 100644
--- a/doc/src/sgml/ref/pg_checksums.sgml
+++ b/doc/src/sgml/ref/pg_checksums.sgml
@@ -38,17 +38,22 @@ PostgreSQL documentation
   <para>
    <application>pg_checksums</application> checks, enables or disables data
    checksums in a <productname>PostgreSQL</productname> cluster.  The server
-   must be shut down cleanly before running
-   <application>pg_checksums</application>. When verifying checksums, the exit
+   must be shut down cleanly before running <application>pg_checksums</application>.
+   Checksums can also be enabled while the cluster is running using
+   <xref linkend="checksums-online-enable-disable"/> processing, see
+   <xref linkend="checksums"/> for further details on the different approaches.
+   When verifying checksums, the exit
    status is zero if there are no checksum errors, and nonzero if at least one
    checksum failure is detected. When enabling or disabling checksums, the
    exit status is nonzero if the operation failed.
   </para>
 
   <para>
-   When enabling checksums, if checksums were in the process of being enabled
-   when the cluster was shut down, <application>pg_checksums</application>
-   will still process all relations regardless of the online processing.
+   When enabling checksums with <application>pg_checksums</application>, if
+   checksums were in the process of being enabled using
+   <xref linkend="checksums-online-enable-disable"/>  when the cluster was shut
+   down, <application>pg_checksums</application> will still process all
+   relation files regardless of the progress of online checksum processing.
   </para>
 
   <para>
diff --git a/doc/src/sgml/wal.sgml b/doc/src/sgml/wal.sgml
index c32931edde3..646076f7e39 100644
--- a/doc/src/sgml/wal.sgml
+++ b/doc/src/sgml/wal.sgml
@@ -276,7 +276,7 @@
 
   </sect2>
 
-  <sect2 id="checksums-online-enable-disable">
+  <sect2 id="checksums-online-enable-disable" xreflabel="Online Enabling of Checksums">
    <title>Online Enabling of Checksums</title>
 
    <para>