Outdated typedefs in documentation

From: Artem Fadeev <a(dot)fadeev(at)postgrespro(dot)ru>
To: pgsql-docs(at)lists(dot)postgresql(dot)org
Subject: Outdated typedefs in documentation
Date: 2025-07-10 00:45:56
Message-ID: 4a742a5b-f081-4313-9241-b8392dfdb114@postgrespro.ru
Views: Whole Thread | Raw Message | Download mbox | Resend email
Thread:
Lists: pgsql-docs

Hi,
I have noticed a slight mismatch between typedefs in docs and header
files. On current master branch:
- CustomScanState is missing custom_ps, pscan_len and slotOps fields
in docs.
- `methods` field of CustomPath, CustomScan and CustomScanState is
missing `struct` in type.
- BrinOpcInfo.oi_regular_nulls is missing.
- pgNotify.next is missing. But the comment above it says apps should
not use it, so I guess it can be left as is.

Attached diff file shows other mismatches I could find. There are some
comments that could be updated. Other differences are caused by
indentation variations and false positives. The script I used for
typedef extraction is also attached.

Regards,
Artem Fadeev.
https://postgrespro.com

Attachment Content-Type Size
typedefs.diff text/x-patch 14.8 KB
typedefs.py text/x-python 3.7 KB

Responses

Browse pgsql-docs by date

  From Date Subject
Next Message Fujii Masao 2025-07-10 07:47:49 Document reopen of output file via SIGHUP in pg_recvlogical
Previous Message Tom Lane 2025-07-09 22:05:46 Re: correction suggestion for https://www.postgresql.org/docs/17/auth-username-maps.html