PFA patch with minor improvements to documentation.
Also, what do you think about changing user-facing language from
"check checksum" to "verify checksum" ? I see that commit ed308d78 actually
moved in the other direction, but I preferred "verify".
>From d8e627cf340e5384d59ab4fc3f3d0b4891a5b1c0 Mon Sep 17 00:00:00 2001
From: Justin Pryzby <[email protected]>
Date: Thu, 28 Mar 2019 19:20:52 -0500
Subject: [PATCH] Clean up pg_checksums.sgml
---
doc/src/sgml/ref/pg_checksums.sgml | 20 ++++++++++----------
1 file changed, 10 insertions(+), 10 deletions(-)
diff --git a/doc/src/sgml/ref/pg_checksums.sgml b/doc/src/sgml/ref/pg_checksums.sgml
index c60695d..9433782 100644
--- a/doc/src/sgml/ref/pg_checksums.sgml
+++ b/doc/src/sgml/ref/pg_checksums.sgml
@@ -39,15 +39,16 @@ PostgreSQL documentation
<application>pg_checksums</application> verifies, enables or disables data
checksums in a <productname>PostgreSQL</productname> cluster. The server
must be shut down cleanly before running
- <application>pg_checksums</application>. The exit status is zero if there
- are no checksum errors when checking them, and nonzero if at least one
- checksum failure is detected. If enabling or disabling checksums, the
+ <application>pg_checksums</application>. 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>
- While verifying or enabling checksums needs to scan or write every file in
- the cluster, disabling checksums will only update the file
+ When verifying checksums, every file in the cluster is scanned;
+ When enabling checksums, every file in the cluster is also rewritten.
+ Disabling checksums only updates the file
<filename>pg_control</filename>.
</para>
</refsect1>
@@ -195,11 +196,10 @@ PostgreSQL documentation
safe.
</para>
<para>
- If <application>pg_checksums</application> is aborted or killed while
- enabling or disabling checksums, the cluster will keep the same
- configuration for data checksums as before the operation attempted.
- <application>pg_checksums</application> can be restarted to
- attempt again the same operation.
+ If <application>pg_checksums</application> is aborted or killed
+ while enabling or disabling checksums, the cluster's checksum state
+ will be unchanged, and <application>pg_checksums</application> would need to
+ be rerun and start its operation from scratch.
</para>
</refsect1>
</refentry>
--
2.1.4
