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 Z7jAm5QSgzf0kRzy@momjian.us
Whole thread Raw
In response to Re: Second paragraph a little bit misleading  (Laurenz Albe <laurenz.albe@cybertec.at>)
Responses Re: Second paragraph a little bit misleading
List pgsql-docs
On Fri, Feb 21, 2025 at 01:42:09PM +0100, Laurenz Albe wrote:
> On Fri, 2025-02-21 at 07:00 -0500, Bruce Momjian wrote:
> > > > 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.
> 
> Hmpf.  The documentation should always be in sync with the code, right?
> So I think it should be left alone in HEAD, and if the checksum change
> gets reverted, your patch should be applied to HEAD.

I see your point, and I now agree that the "Reliability" section was
just overlooked when the data checksum default was changed.  I made a
larger patch which improved the wording of data checksum mentions now
that it is the default in master.

I also fixed the Felix-reported problem in all the back branches through
14 --- PG 13 did not have the problem.

Patches attached.

-- 
  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: Laurenz Albe
Date:
Subject: Re: Second paragraph a little bit misleading
Next
From: Brad DeJong
Date:
Subject: dynamic monitoring