Re: A question about wording in messages

At Tue, 13 Sep 2022 22:38:46 -0400, Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us> wrote in
> Kyotaro Horiguchi <horikyota(dot)ntt(at)gmail(dot)com> writes:
> > I saw the following message recently modified.
> >> This controls the maximum distance we can read ahead in the WAL to prefetch referenced data blocks.
> > Maybe the "we" means "PostgreSQL program and you" but I see it
> > somewhat out of place.
>
> +1, I saw that today and thought it was outside our usual style.
> The whole thing is awfully verbose for a GUC description, too.
> Maybe
>
> "Maximum distance to read ahead in WAL to prefetch data blocks."

It seems to sufficiently work for average users and rather easy to
read, but it looks a short description.

wal_decode_buffer_size has the following descriptions.

Short: Buffer size for reading ahead in the WAL during recovery.
Extra: This controls the maximum distance we can read ahead in the WAL to prefetch referenced data blocks.

So, taking the middle of them, how about the following?

Short: Buffer size for reading ahead in the WAL during recovery.
Extra: This controls the maximum distance to read ahead in WAL to prefetch data blocks."

regards.

--
Kyotaro Horiguchi
NTT Open Source Software Center