Re: Detailed release notes

On Sat, Sep 7, 2024 at 6:30 AM Jelte Fennema-Nio <postgres(at)jeltef(dot)nl> wrote:
>
> On Thu, 22 Aug 2024 at 21:34, Marcos Pegoraro <marcos(at)f10(dot)com(dot)br> wrote:
> > I understand your point, and agree with that for previous releases, but since we have a month only for version 17, will this process work properly until that date ?
> > I think a release notes is more read as soon as it is available than other months, isn't it ?
> > And this feature is just a HTML page, so if it's done manually or automatically, from the reader point of view it'll be exactly the same.
>
> Big +1 to this. It would definitely be great if we would have these
> commit links for previous release notes. But the PG17 GA release is
> probably happening in 19 days on September 26th. I feel like we should
> focus on getting the manual improvements from Jian He merged,
> otherwise we'll end up with release notes for PG17 on release day that
> are significantly less useful than they could have been. Let's not
> make perfect the enemy of good here.
>

hi. Thanks for your interest.
patch updated.

I have proof-read release-17.sgml again,
making sure the commit url's commit is the same as
release-17.sgml comment's git commit.

like:

<!--
Author: Jeff Davis <jdavis(at)postgresql(dot)org>
2024-03-04 [2af07e2f7] Fix search_path to a safe value during maintenance opera
-->

<listitem>
<para>
Change functions to use a safe <xref linkend="guc-search-path"/>
during maintenance operations (Jeff Davis).
[<ulink url="&commit_baseurl;2af07e2f7">2af07e2f7</ulink>]
</para>

make sure there are three occurence of "2af07e2f7".

I didn't manually click each git commit url to test it though.

----------------------------
there are at least several typos in sgml comment.
like

<!--
Author: Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>
2023-11-17 [f7816aec2] Extract column statistics from CTE references, if possib
Author: Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>
2024-03-26 [a65724dfa] Propagate pathkeys from CTEs up to the outer query.
-->

here should be "possible".

it seems using sgml comments to automate some things, we still need
extra effort to proof-read.