From: Michael Paquier <michael@paquier.xyz>
Date: Mon, 8 Apr 2019 06:30:45 +0000 (+0900)
Subject: Tweak wording of documentation for pg_checksums
X-Git-Tag: REL_12_BETA1~275
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=e3865c37544d77bd4205dd5361592797b97d1e93;p=postgresql

Tweak wording of documentation for pg_checksums

Author: Justin Pryzby
Discussion: https://postgr.es/m/20190329143210.GI5815@telsasoft.com
---

diff --git a/doc/src/sgml/ref/pg_checksums.sgml b/doc/src/sgml/ref/pg_checksums.sgml
index 47d4a626de..a0ffeb0ab0 100644
--- a/doc/src/sgml/ref/pg_checksums.sgml
+++ b/doc/src/sgml/ref/pg_checksums.sgml
@@ -39,16 +39,16 @@ PostgreSQL documentation
    <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>. 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 checking or enabling checksums needs to scan or write every file in
-   the cluster, disabling checksums will only update the file
-   <filename>pg_control</filename>.
+   When verifying checksums, every file in the cluster is scanned. When
+   enabling checksums, every file in the cluster is rewritten. Disabling
+   checksums only updates the file <filename>pg_control</filename>.
   </para>
  </refsect1>
 
@@ -218,10 +218,9 @@ PostgreSQL documentation
   </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.
+   enabling or disabling checksums, the cluster's data checksum configuration
+   remains unchanged, and <application>pg_checksums</application> can be
+   re-run to perform the same operation.
   </para>
  </refsect1>
 </refentry>