pg.ddx.io  pgsql-committers@postgresql.org mailing list archive  
help / color / mirror / Atom feed
From: Andrew Dunstan <andrew@dunslane.net>
To: pgsql-committers@lists.postgresql.org
Subject: pgsql: Improve docs syntax checking
Date: Thu, 02 Oct 2025 18:28:44 +0000
Message-ID: <E1v4O2l-0018fZ-34@gemulon.postgresql.org> (raw)

Improve docs syntax checking

Move the checks out of the Makefile into a perl script that can be
called from both the Makefile and meson.build. The set of files checked
is simplified, so it is just all the sgml and xsl files found in
docs/src/sgml directory tree.

Along the way make some adjustments to .cirrus.tasks.yml to support this
better in CI.

Also ensure that the checks are part of the Makefile's html target.

Author: Nazir Bilal Yavuz <byavuz81@gmail.com>
Co-Author: Andrew Dunstan <andrew@dunslane.net>

Discussion: https://postgr.es/m/CAN55FZ3BnM+0twT-ZWL8As9oBEte_b+SBU==cz6Hk8JUCM_5Wg@mail.gmail.com

Branch
------
master

Details
-------
https://git.postgresql.org/pg/commitdiff/b292256272623d1a7532f3893a4565d1944742b4

Modified Files
--------------
.cirrus.tasks.yml                 |  3 ++
doc/src/sgml/Makefile             | 18 ++-------
doc/src/sgml/meson.build          | 23 ++++++++++++
doc/src/sgml/sgml_syntax_check.pl | 77 +++++++++++++++++++++++++++++++++++++++
4 files changed, 106 insertions(+), 15 deletions(-)



Message-ID: <E1v4O2l-0018fZ-34@gemulon.postgresql.org>
Permalink:  ../E1v4O2l-0018fZ-34@gemulon.postgresql.org/
Also on:    postgresql.org/message-id/E1v4O2l-0018fZ-34@gemulon.postgresql.org

 · 

reply

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Reply to all the recipients using the --to and --cc options:
  reply via email

  To: pgsql-committers@postgresql.org
  Cc: andrew@dunslane.net, pgsql-committers@lists.postgresql.org
  Subject: Re: pgsql: Improve docs syntax checking
  In-Reply-To: <E1v4O2l-0018fZ-34@gemulon.postgresql.org>

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

This inbox is served by DDX for PostgreSQL; see mirroring instructions
for how to clone and mirror all data and code used for this inbox