Re: Can we delete the vacuumdb.sgml notes about which version each option was added in?

From: Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>
To: Justin Pryzby <pryzby(at)telsasoft(dot)com>
Cc: David Rowley <dgrowleyml(at)gmail(dot)com>, pgsql-hackers(at)lists(dot)postgresql(dot)org
Subject: Re: Can we delete the vacuumdb.sgml notes about which version each option was added in?
Date: 2023-04-16 14:29:48
Message-ID: 2178623.1681655388@sss.pgh.pa.us
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

Justin Pryzby <pryzby(at)telsasoft(dot)com> writes:
> On Sun, Apr 16, 2023 at 10:14:35PM +1200, David Rowley wrote:
>> Does anyone think we should keep these?

> I don't know if I'd support removing the notes, but I agree that they
> don't need to take up anywhere near as much space as they do (especially
> since the note is now repeated 10 times).

I agree with removing the notes. It has always been our policy that
you should read the version of the manual that applies to the version
you're running. I can see leaving a compatibility note around for a
long time when it's warning you that some behavior changed compared
to what the same syntax used to do. But if a switch simply isn't
there in some older version, that's not terribly dangerous or hard to
figure out.

> I suggest to remove the <note> markup and preserve the annotation about
> version compatibility. It's normal, technical writing to repeat the
> same language like that.

Another way could be to move them all into a "Compatibility" section.
But +1 for just dropping them.

regards, tom lane

In response to

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Mikael Kjellström 2023-04-16 14:51:04 Re: Direct I/O
Previous Message Tom Lane 2023-04-16 14:23:23 Re: idea: multiple arguments to_regclass function