Fix improper xreflabels created for v18 release notes

From: Robert Treat <rob(at)xzilla(dot)net>
To: pgsql-docs(at)lists(dot)postgresql(dot)org
Cc: Bruce Momjian <bruce(at)momjian(dot)us>
Subject: Fix improper xreflabels created for v18 release notes
Date: 2026-01-01 16:55:27
Message-ID: CABV9wwNEZDdp5QtrW5ut0H+MOf6U1PvrqBqmgSTgcixqk+Q73A@mail.gmail.com
Views: Whole Thread | Raw Message | Download mbox | Resend email
Thread:
Lists: pgsql-docs

Looking at https://www.postgresql.org/docs/current/xplang.html during
a near by discussion, I was bothered that plpython was not formatting
the same way as the other PL's listed on that page, so I went
spelunking to see what had happened.

It turns out that some xref labels were added during this commit
(https://github.com/postgres/postgres/commit/d8aa21b74ff4e3d767c3344484c3cb22b9f0ec0d)
in order to make the links more readable in the v18 release notes.

However, based on the discussion here:
https://www.postgresql.org/message-id/20200611223836.GA2507%40momjian.us,
the correct way to style links from the release notes is through the
<link> tag, not by adding xrefs, which can have unintended
side-effects in other places (like in the initial doc link above).

This is a little tricky to fix as it needs to happen across 2
different branches, but I believe the right way to fix this involves 2
parts. First, apply patch 01, which converts the xrefs in the v18
release notes to link tags, against REL_18_STABLE, since those release
notes don't exist on master.

Second, either revert the original commit linked above, or apply the
patch 02 which just undoes those changes. Note, I created the patch
against master, but I think it should be applied there and back
patched to 18 stable.

Also note I did a quick scan to see if either the liboq or plpython
xreflabel situation existed elsewhere but I only turned up one usage,
at https://www.postgresql.org/docs/current/triggers.html, which is
also corrected with these changes.

Robert Treat
https://xzilla.net

Attachment Content-Type Size
v1-0001-Replace-improper-use-of-xrefs-with-links.patch application/octet-stream 1.2 KB
v1-0002-Remove-libpq-plpython-xreflabel-from-chapter-tags.patch application/octet-stream 1.3 KB

Browse pgsql-docs by date

  From Date Subject
Next Message Babak Ghadiri 2026-01-02 07:55:07 Parallelizing startup with many databases
Previous Message Robert Treat 2025-12-31 15:39:20 Re: Index / glossary adjustments for Git & GUC