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

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

On Wed, Jan 8, 2025 at 8:39 AM Peter Eisentraut <peter(at)eisentraut(dot)org> wrote:
>
> On 07.01.25 18:31, Melanie Plageman wrote:
> >
> > Oh, one thing I forgot to say. Though I increased the indentation of
> > some of the subsections that I moved, I didn't rewrap the lines
> > because they were already not wrapped to 78. I can do this, but I
> > can't tell from the existing docs what text width the paragraphs of
> > text are supposed to be wrapped to.
>
> For a patch that moves things around like this, I would leave everything
> as is and not rewrap. That makes it easier to follow what's going on
> with "git diff -w", "git show -w" etc.
>
> In .dir-locals.el, there is this configuration for Emacs:
>
> (nxml-mode . ((fill-column . 78)
> (indent-tabs-mode . nil)))
>
> So that's one data point about what the line length should be.

Well, in this case, the diff won't look different with git show/diff
-w because moving them to another part of the file is more than a
whitespace change. For clarity, I added a note to the commit message
that the actual GUCs' docs are just lifted and shifted.

I decided in the end not to wrap it anyway, though. I tried it and
didn't like the result. If I wrap it to 78, that actually makes a good
number of the GUCs' docs wider (i.e. they were wrapped to less than
78). Which means future additions are more likely to need to wrap (as
Tom mentioned upthread).

Attached is v2 (required a rebase).

- Melanie

Attachment Content-Type Size
v2-0001-Consolidate-docs-for-vacuum-related-GUCs-in-new-s.patch application/octet-stream 60.8 KB

In response to

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Masahiko Sawada 2025-01-09 01:48:21 Re: Conflict detection for update_deleted in logical replication
Previous Message Melanie Plageman 2025-01-09 01:30:17 Re: Moving the vacuum GUCs' docs out of the Client Connection Defaults section