Message-ID: <43db6e44e5bc8c6f22eb439c8256f1e1bc135cf7.camel@cybertec.at>
Subject: Re: Second paragraph a little bit misleading
From: Laurenz Albe <laurenz.albe@cybertec.at>
To: Bruce Momjian <bruce@momjian.us>, afripowered@gmail.com,
	pgsql-docs@lists.postgresql.org
Date: Fri, 21 Feb 2025 08:25:56 +0100
In-Reply-To: <Z7dak8fwxwezBhyh@momjian.us>
References: <173928241056.707.3989867022954178032@wrigleys.postgresql.org>
	 <Z7dak8fwxwezBhyh@momjian.us>
User-Agent: Evolution 3.54.3 (3.54.3-1.fc41) 
MIME-Version: 1.0
Content-Type: text/plain; charset="UTF-8"
Archived-At: 
 <https://www.postgresql.org/message-id/43db6e44e5bc8c6f22eb439c8256f1e1bc135cf7.camel%40cybertec.at>
Precedence: bulk

On Thu, 2025-02-20 at 11:38 -0500, Bruce Momjian wrote:
> On Tue, Feb 11, 2025 at 02:00:10PM +0000, PG Doc comments form wrote:
> > Page: https://www.postgresql.org/docs/17/checksums.html
> > 
> > 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.
> 
> 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.
>
> 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

The change looks good for the back branches, but the default has changed
in v18: now checksums are the default.  So "can be enabled" doesn't sound
right for v18.  I'd leave "are normally enabled" in HEAD.

Yours,
Laurenz Albe

-- 

*E-Mail Disclaimer*
Der Inhalt dieser E-Mail ist ausschliesslich fuer den 
bezeichneten Adressaten bestimmt. Wenn Sie nicht der vorgesehene Adressat 
dieser E-Mail oder dessen Vertreter sein sollten, so beachten Sie bitte, 
dass jede Form der Kenntnisnahme, Veroeffentlichung, Vervielfaeltigung oder 
Weitergabe des Inhalts dieser E-Mail unzulaessig ist. Wir bitten Sie, sich 
in diesem Fall mit dem Absender der E-Mail in Verbindung zu setzen.

*CONFIDENTIALITY NOTICE & DISCLAIMER
*This message and any attachment are 
confidential and may be privileged or otherwise protected from disclosure 
and solely for the use of the person(s) or entity to whom it is intended. 
If you have received this message in error and are not the intended 
recipient, please notify the sender immediately and delete this message and 
any attachment from your system. If you are not the intended recipient, be 
advised that any use of this message is prohibited and may be unlawful, and 
you must not copy this message or attachment or disclose the contents to 
any other person.