MIME-Version: 1.0
References: <ZtpgHSGPrQNTZ-mX@momjian.us> <202409070955.wyuhquqflbxg@alvherre.pgsql>
 <Zt-zGmTub6eK_Z7W@momjian.us>
In-Reply-To: <Zt-zGmTub6eK_Z7W@momjian.us>
From: Jelte Fennema-Nio <postgres@jeltef.nl>
Date: Tue, 10 Sep 2024 08:28:42 +0200
Message-ID: <CAGECzQQfRVehQON65qNu-T_1O7VE+aFi0uPgvSEG4PHaijbUiw@mail.gmail.com>
Subject: Re: First draft of PG 17 release notes
To: Bruce Momjian <bruce@momjian.us>
Cc: Alvaro Herrera <alvherre@alvh.no-ip.org>, Nathan Bossart <nathandbossart@gmail.com>, 
	pgsql-hackers@postgresql.org
Content-Type: text/plain; charset="UTF-8"
Archived-At: <https://www.postgresql.org/message-id/CAGECzQQfRVehQON65qNu-T_1O7VE%2BaFi0uPgvSEG4PHaijbUiw%40mail.gmail.com>
Precedence: bulk

On Tue, 10 Sept 2024 at 04:47, Bruce Momjian <bruce@momjian.us> wrote:
> Yes.  There are so many changes at the source code level it is unwise to
> try and get them into the main release notes.  If someone wants to
> create an addendum, like was suggested for pure performance
> improvements, that would make sense.

I agree that the release notes cannot fit every change. But I also
don't think any extension author reads the complete git commit log
every release, so taking the stance that they should be seems
unhelpful. And the "Source Code" section does exist so at some level
you seem to disagree with that too. So what is the way to decide that
something makes the cut for the "Source Code" section?

I think as an extension author there are usually three types of
changes that are relevant:
1. New APIs/hooks that are meant for extension authors
2. Stuff that causes my existing code to not compile anymore
3. Stuff that changes behaviour of existing APIs code in a
incompatible but silent way

For 1, I think adding them to the release notes makes total sense,
especially if the new APIs are documented not only in source code, but
also on the website. Nathan his change is of this type, so I agree
with him it should be in the release notes.

For 2, I'll be able to easily find the PG commit that caused the
compilation failure by grepping git history for the old API. So having
these changes in the release notes seems unnecessary.

For 3, it would be very useful if it would be in the release notes,
but I think in many cases it's hard to know what commits do this. So
unless it's obviously going to break a bunch of extensions silently, I
think we don't have to add such changes to the release notes.