Re: Improve docs syntax checking and enable it in the meson build

From: Nazir Bilal Yavuz <byavuz81(at)gmail(dot)com>
To: Peter Eisentraut <peter(at)eisentraut(dot)org>
Cc: PostgreSQL Hackers <pgsql-hackers(at)lists(dot)postgresql(dot)org>, Andrew Dunstan <andrew(at)dunslane(dot)net>, Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>, Álvaro Herrera <alvherre(at)kurilemu(dot)de>, Bruce Momjian <bruce(at)momjian(dot)us>
Subject: Re: Improve docs syntax checking and enable it in the meson build
Date: 2025-10-22 08:04:18
Message-ID: CAN55FZ0=9PzKud+QrTLEF2j28Cn7Aphx3EEHZhgHYtuCkKMFug@mail.gmail.com
Views: Whole Thread | Raw Message | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

Hi,

Thank you for looking into this!

On Wed, 15 Oct 2025 at 21:32, Peter Eisentraut <peter(at)eisentraut(dot)org> wrote:
>
> On 07.10.25 15:12, Nazir Bilal Yavuz wrote:
> > 1 - A new sgml_syntax_check.pl script was added to handle tab, nbsp,
> > and xmllint validation checks.
> > 1.1 - It is registered as the sgml_syntax_check test in the Meson build.
> > 1.2 - These checks are run when executing 'make check' or 'meson test
> > sgml_syntax_check' commands.
> > 1.3 - During the creation of postgres-full.xml, the script performs
> > tab and nbsp checks. The xmllint check is skipped there, since
> > validation is already handled by the --valid option. So, we do not run
> > the same check twice.
>
> I think including the xmllint support in the new sgml_syntax_check is
> overkill, since the normal build already runs xmllint, or you could
> alternatively just write it into the build description file (makefile or
> meson.build). The build commands should be visible in the build
> description file, not layered into some other script.
>
> I suggest the following approach:
>
> - Change sgml_syntax_check.pl into a smaller script that just checks for
> tabs and nbsp. (Maybe a different name then.)
>
> - Add a call of that script to the build of postgres-full.xml.
>
> - Change the "check" target to just depend on postgres-full.xml, without
> its own commands.
>
> And then replicate that logic in meson.

All of these are addressed in v7. I think sgml_syntax_check is still a
suitable name but I am open to suggestions.

--
Regards,
Nazir Bilal Yavuz
Microsoft

Attachment Content-Type Size
v7-0001-Improve-docs-syntax-checking.patch text/x-patch 7.4 KB

In response to

Browse pgsql-hackers by date

  From Date Subject
Next Message Shinya Kato 2025-10-22 08:04:58 Add wal_fpi_bytes_[un]compressed to pg_stat_wal
Previous Message Xuneng Zhou 2025-10-22 07:49:18 Re: Fix lag columns in pg_stat_replication not advancing when replay LSN stalls