agora inbox for pgsql-docs@postgresql.org  
help / color / mirror / Atom feed
From: Bruce Momjian <bruce@momjian.us>
To: Laurenz Albe <laurenz.albe@cybertec.at>
Cc: afripowered@gmail.com
Cc: pgsql-docs@lists.postgresql.org
Subject: Re: Second paragraph a little bit misleading
Date: Fri, 21 Feb 2025 07:00:32 -0500
Message-ID: <Z7hq4D_QMwR85DOO@momjian.us> (raw)
In-Reply-To: <43db6e44e5bc8c6f22eb439c8256f1e1bc135cf7.camel@cybertec.at>
References: <173928241056.707.3989867022954178032@wrigleys.postgresql.org>
	<Z7dak8fwxwezBhyh@momjian.us>
	<43db6e44e5bc8c6f22eb439c8256f1e1bc135cf7.camel@cybertec.at>

On Fri, Feb 21, 2025 at 08:25:56AM +0100, Laurenz Albe wrote:
> 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.

Yes, I was confused about that too, but I think we changed the code for
the development branch and if we decide to keep the new default, we will
change the docs later.  I didn't want to interfere with that.

-- 
  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.





view thread (7+ messages)  latest in thread

Message-ID: <Z7hq4D_QMwR85DOO@momjian.us>
Permalink:  ../Z7hq4D_QMwR85DOO@momjian.us/
Also on:    postgresql.org/message-id/Z7hq4D_QMwR85DOO@momjian.us

reply

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-docs@postgresql.org
  Cc: bruce@momjian.us, laurenz.albe@cybertec.at, afripowered@gmail.com, pgsql-docs@lists.postgresql.org
  Subject: Re: Second paragraph a little bit misleading
  In-Reply-To: <Z7hq4D_QMwR85DOO@momjian.us>

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

This inbox is served by agora; see mirroring instructions
for how to clone and mirror all data and code used for this inbox