Date: Thu, 20 Feb 2025 11:38:43 -0500
From: Bruce Momjian <bruce@momjian.us>
To: afripowered@gmail.com, pgsql-docs@lists.postgresql.org
Subject: Re: Second paragraph a little bit misleading
Message-ID: <Z7dak8fwxwezBhyh@momjian.us>
References: <173928241056.707.3989867022954178032@wrigleys.postgresql.org>
MIME-Version: 1.0
Content-Type: multipart/mixed; boundary="T7q5L8QLecnkcOOH"
Content-Disposition: inline
In-Reply-To: <173928241056.707.3989867022954178032@wrigleys.postgresql.org>
Archived-At: 
 <https://www.postgresql.org/message-id/Z7dak8fwxwezBhyh%40momjian.us>
Precedence: bulk


--T7q5L8QLecnkcOOH
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline

On Tue, Feb 11, 2025 at 02:00:10PM +0000, PG Doc comments form wrote:
> The following documentation comment has been logged on the website:
> 
> Page: https://www.postgresql.org/docs/17/checksums.html
> Description:
> 
> Hi there,
> 
> I think that the first sentence of the second paragraph in this page is a
> little bit misleading. The first paragraph states that checksums are not
> enabled by default. The first sentence in the second paragraph sounds like
> it IS enabled by default when using initdb, but you have to pass -k
> explicitly.
> 
> As far as I understood, it's a good idea to enable this and that is what the
> beginning of the second paragraph means.
> 
> Maybe a sentence like "Checksums should normally be enabled when the cluster
> is initialized using initdb" instead of "are" - or "It's recommended to
> enable Checksums when initializing a cluster using initdb".

I can see your point.  Attached is a doc patch that improves it.  I
chose very simple language and plan to backpatch this to all supported
versions.

-- 
  Bruce Momjian  <bruce@momjian.us>        https://momjian.us
  EDB                                      https://enterprisedb.com

  Do not let urgent matters crowd out time for investment in the future.

--T7q5L8QLecnkcOOH
Content-Type: text/x-diff; charset=us-ascii
Content-Disposition: attachment; filename="checksum.diff"

diff --git a/doc/src/sgml/wal.sgml b/doc/src/sgml/wal.sgml
index 52b5b8f793b..705ca682777 100644
--- a/doc/src/sgml/wal.sgml
+++ b/doc/src/sgml/wal.sgml
@@ -246,7 +246,7 @@
   </para>
 
   <para>
-   Checksums are normally enabled when the cluster is initialized using <link
+   Checksums can be enabled when the cluster is initialized using <link
    linkend="app-initdb-data-checksums"><application>initdb</application></link>.
    They can also be enabled or disabled at a later time as an offline
    operation. Data checksums are enabled or disabled at the full cluster

--T7q5L8QLecnkcOOH--