Tweak wording of documentation for pg_checksums
authorMichael Paquier
Mon, 8 Apr 2019 06:30:45 +0000 (15:30 +0900)
committerMichael Paquier
Mon, 8 Apr 2019 06:30:45 +0000 (15:30 +0900)
Author: Justin Pryzby
Discussion: https://postgr.es/m/20190329143210[email protected]

doc/src/sgml/ref/pg_checksums.sgml

index 47d4a626decc69237c669a7e18e64d7bb2363daa..a0ffeb0ab04e0eecd958536e911d63ad28a2d832 100644 (file)
@@ -39,16 +39,16 @@ PostgreSQL documentation
    pg_checksums checks, enables or disables data
    checksums in a PostgreSQL cluster.  The server
    must be shut down cleanly before running
-   pg_checksumsThe 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
+   pg_checksumsWhen 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.
   
 
   
-   While checking or enabling checksums needs to scan or write every file in
-   the cluster, disabling checksums will only update the file
-   pg_control.
+   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 pg_control.
   
  
 
@@ -218,10 +218,9 @@ PostgreSQL documentation
   
   
    If pg_checksums is aborted or killed while
-   enabling or disabling checksums, the cluster will keep the same
-   configuration for data checksums as before the operation attempted.
-   pg_checksums can be restarted to
-   attempt again the same operation.
+   enabling or disabling checksums, the cluster's data checksum configuration
+   remains unchanged, and pg_checksums can be
+   re-run to perform the same operation.