Re: Detailed release notes

On Fri, Jul 26, 2024 at 10:11:22AM -0400, Tom Lane wrote:
> Daniel Gustafsson <daniel(at)yesql(dot)se> writes:
> >> On 26 Jul 2024, at 15:00, Marcos Pegoraro <marcos(at)f10(dot)com(dot)br> wrote:
> >> But why is that just a hidden comment and not a visible link for us ?
>
> > That's likely the wrong level of detail for the overwhelming majority of
> > release notes readers. I have a feeling this was discussed not too long ago
> > but (if so) I fail to find that discussion now.
>
> Yeah, I too recall some discussion of surfacing the commit links
> somehow, perhaps as a popup tooltip. Nobody's got round to it yet.
> It's not real clear how to handle multiple links per <para>, which
> happens from time to time in major release notes and just about
> everyplace in minor release notes.

Yes, some kind of popup is what I remember. Looking at the HTML output
for the docs, the SGML comments don't appear the HTML, so I think we
need to write a Perl or shell script to match all the SGML <listitem>
comment text with the HTML <li> text, and insert tooltip text with links
for every one of them. Should I work on this?

--
Bruce Momjian <bruce(at)momjian(dot)us> https://momjian.us
EDB https://enterprisedb.com

Only you can decide what is important to you.