Re: pgsql: doc: fix wording describing the checkpoint_flush_after GUC

From: Andres Freund <andres(at)anarazel(dot)de>
To: Alvaro Herrera <alvherre(at)alvh(dot)no-ip(dot)org>
Cc: Bruce Momjian <bruce(at)momjian(dot)us>, pgsql-hackers(at)lists(dot)postgresql(dot)org
Subject: Re: pgsql: doc: fix wording describing the checkpoint_flush_after GUC
Date: 2023-11-14 20:01:47
Message-ID: 20231114200147.dwkb4uuzg76yuoav@awork3.anarazel.de
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-committers pgsql-hackers

Hi,

On 2023-11-14 17:49:59 +0100, Alvaro Herrera wrote:
> On 2023-Nov-13, Andres Freund wrote:
> > On 2023-11-13 12:31:42 +0100, Alvaro Herrera wrote:
> > > On 2023-Nov-09, Bruce Momjian wrote:
> > >
> > > > doc: fix wording describing the checkpoint_flush_after GUC
> > >
> > > Hmm. Is this new wording really more clear than the original wording?
> > > I agree the original may not have been the most simple, but I don't
> > > think it was wrong English.
> >
> > I think it was somewhat wrong (I probably wrote it) or at least awkwardly
> > formulated. "force the OS that pages .. should be flushed" doesn't make a ton
> > of sense.
>
> Heh, you know what? I was mistaken. There was indeed a grammatical
> error being fixed. The complaint [1] was that "you" was missing in the
> sentence, and apparently that's correct [2].

> [1] https://postgr.es/m/155208475619.1380.12815553062985622271@wrigleys.postgresql.org
> [2] https://english.stackexchange.com/a/60285

Hm, I really can't get excited about this. To me the "you" sounds worse, but
whatever...

> > OTOH, the new formulation doesn't seem great either. The request(s) that we
> > make to the OS are not guaranteed to be followed, so the "should be" was
> > actually a correct part of the sentence.
>
> Hmm, I hadn't noticed that nuance. Your text looks OK to me, except
> that "... after a configurable number of bytes" reads odd after what's
> already in the sentence. I would rewrite it in a different form, maybe
>
> On Linux and POSIX platforms, checkpoint_flush_after specifies the
> number of bytes written by a checkpoint after which the OS is requested
> to flush pages to disk. Otherwise, these pages ...

That works for me!

Greetings,

Andres Freund

In response to

Responses

Browse pgsql-committers by date

  From Date Subject
Next Message Michael Paquier 2023-11-15 00:46:11 pgsql: doc: Improve description of targets for pg_stat_reset_shared()
Previous Message Alvaro Herrera 2023-11-14 16:49:59 Re: pgsql: doc: fix wording describing the checkpoint_flush_after GUC

Browse pgsql-hackers by date

  From Date Subject
Next Message Peter Eisentraut 2023-11-14 20:16:13 Re: meson documentation build open issues
Previous Message Tom Lane 2023-11-14 19:47:42 Re: Why do indexes and sorts use the database collation?