public inbox for [email protected]
help / color / mirror / Atom feedFrom: Daniel Gustafsson <[email protected]>
To: Bruce Momjian <[email protected]>
Cc: PostgreSQL-documentation <[email protected]>
Subject: Re: pg_checksums docs mentioning online functions
Date: Thu, 4 Jun 2026 22:39:53 +0200
Message-ID: <[email protected]> (raw)
In-Reply-To: <[email protected]>
References: <[email protected]>
<[email protected]>
<[email protected]>
> On 4 Jun 2026, at 22:12, Bruce Momjian <[email protected]> wrote:
> My big issue is that we explain the limitation of pg_checksums, but
> don't point readers at the tool that doesn't have that offline
> restriction. I think we need that explicitly mentioned, and at the top.
How about something like the attached?
--
Daniel Gustafsson
Attachments:
[application/octet-stream] pg_checksums_docs.diff (2.1K, 2-pg_checksums_docs.diff)
download | inline diff:
diff --git a/doc/src/sgml/ref/pg_checksums.sgml b/doc/src/sgml/ref/pg_checksums.sgml
index 45890324075..d1048d43f11 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 progress of the online 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>
view thread (6+ messages) latest in thread
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: [email protected]
Cc: [email protected], [email protected], [email protected]
Subject: Re: pg_checksums docs mentioning online functions
In-Reply-To: <[email protected]>
* 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