From: Justin Pryzby <pryzby@telsasoft.com>
To: Michael Paquier <michael@paquier.xyz>
Cc: pgsql-hackers@postgresql.org
Subject: clean up pg_checksums.sgml
Date: Fri, 29 Mar 2019 09:32:10 -0500
Message-ID: <20190329143210.GI5815@telsasoft.com> (raw)
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".
Attachments:0001-Clean-up-pg_checksums.sgml.patch (text/x-diff, 2.3K) download
From d8e627cf340e5384d59ab4fc3f3d0b4891a5b1c0 Mon Sep 17 00:00:00 2001
From: Justin Pryzby <pryzbyj@telsasoft.com>
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.sgmlindex 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
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: pgsql-hackers@postgresql.org
Cc: pryzby@telsasoft.com, michael@paquier.xyz
Subject: Re: clean up pg_checksums.sgml
In-Reply-To: <20190329143210.GI5815@telsasoft.com>
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
This inbox is served by DDX for PostgreSQL; see mirroring instructions
for how to clone and mirror all data and code used for this inbox