Re: Second paragraph a little bit misleading - Mailing list pgsql-docs

From Bruce Momjian
Subject Re: Second paragraph a little bit misleading
Date
Msg-id Z7dak8fwxwezBhyh@momjian.us
Whole thread Raw
In response to Second paragraph a little bit misleading  (PG Doc comments form <noreply@postgresql.org>)
Responses Re: Second paragraph a little bit misleading
List pgsql-docs
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.

Attachment

pgsql-docs by date:

Previous
From: Shlok Kyal
Date:
Subject: Re: pg_copy_logical_replication_slot doesn't copy the failover property
Next
From: Masahiko Sawada
Date:
Subject: Re: pg_copy_logical_replication_slot doesn't copy the failover property