Re: Moving the vacuum GUCs' docs out of the Client Connection Defaults section

From: Melanie Plageman <melanieplageman(at)gmail(dot)com>
To: Daniel Gustafsson <daniel(at)yesql(dot)se>
Cc: Peter Eisentraut <peter(at)eisentraut(dot)org>, Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>, PostgreSQL Hackers <pgsql-hackers(at)postgresql(dot)org>, "Bossart, Nathan" <bossartn(at)amazon(dot)com>
Subject: Re: Moving the vacuum GUCs' docs out of the Client Connection Defaults section
Date: 2025-01-10 23:31:04
Message-ID: CAAKRu_ZochwEBbY7_1n8z_-c5Zvh1EggBkEhYn2i9X4A5LD4ww@mail.gmail.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

On Fri, Jan 10, 2025 at 6:00 PM Daniel Gustafsson <daniel(at)yesql(dot)se> wrote:
>
> > On 10 Jan 2025, at 23:09, Melanie Plageman <melanieplageman(at)gmail(dot)com> wrote:
> >
> > On Thu, Jan 9, 2025 at 5:05 PM Daniel Gustafsson <daniel(at)yesql(dot)se> wrote:
> >>
> >> I think this is a really good restructuring which will make life easier for our
> >> users. Some of the comments below are on wording which wasn't introduced in
> >> this patch, but which I hadn't thought about before, so feel free to ignore
> >> those comments.
> >>
> >> + <sect2 id="runtime-config-vacuum-freezing">
> >> + <title>Freezing</title>
> >> +
> >> + <para>
> >> Trying to read this as a new user, I think it would be good to start this
> >> subsection with a sentence describing what freezing actually is. Vacuum is
> >> hard enough for users as it is =)
> >
> > I've taken a stab at improving this. Let me know if you think it works.
>
> I like what you added, it's IMO the right level of detail here.

Cool, thanks! I pushed.

> + Specifies the cutoff age (in multixacts) that <command>VACUUM</command>
> I wish we had a glossary entry for multixact we could link to here. But,
> that's not really the responsibility of this patch to fix, just something that
> came to mind when reading the resulting page.

Personally, I really wish we had a docs page explaining more about
what mutlixacts are and maybe even a bit about the architecture. FWIW,
the index [1] has an entry for MultiXacts but it goes straight to
MultiXacts and Wraparound [2].

- Melanie

[1] https://www.postgresql.org/docs/devel/bookindex.html
[2] https://www.postgresql.org/docs/devel/routine-vacuuming.html#VACUUM-FOR-MULTIXACT-WRAPAROUND

In response to

Browse pgsql-hackers by date

  From Date Subject
Next Message Tom Lane 2025-01-10 23:32:03 Re: Restore support for USE_ASSERT_CHECKING in extensions only
Previous Message Tatsuo Ishii 2025-01-10 23:25:48 Re: Proposal: add new API to stringinfo