MIME-Version: 1.0
From: Daniele Varrazzo <daniele.varrazzo@gmail.com>
Date: Sun, 19 Apr 2026 16:54:02 +0100
Message-ID: 
 <CA+mi_8aEyKfLG3_+x7uU6HBYtOug3HYFRq1sz7JB7N89=EmKUA@mail.gmail.com>
Subject: Improve PQauthDataHook_type docs
To: pgsql-docs@lists.postgresql.org
Content-Type: multipart/mixed; boundary="00000000000096017b064fd2319b"
Archived-At: 
 <https://www.postgresql.org/message-id/CA%2Bmi_8aEyKfLG3_%2Bx7uU6HBYtOug3HYFRq1sz7JB7N89%3DEmKUA%40mail.gmail.com>
Precedence: bulk

--00000000000096017b064fd2319b
Content-Type: text/plain; charset="UTF-8"

Hello,

In https://www.postgresql.org/docs/18/libpq-oauth.html#LIBPQ-OAUTH-AUTHDATA-HOOKS
it is not entirely clear that `hook_fn` is the definition of the
`PQauthDataHook_type` used in the functions signature, because the
name is not used elsewhere. The function signatures refer to the
typedef but the typedef is not shown.

Using https://www.postgresql.org/docs/18/libpq-notice-processing.html#LIBPQ-NOTICE-PROCESSING
as a guideline I suggest to show the typedef of the callback rather
than the `hook_fn` example, so that the `PQauthDataHook_type` name can
be searched for.

Please check the patch attached.

Cheers

-- Daniele

--00000000000096017b064fd2319b
Content-Type: text/x-patch; charset="US-ASCII";
	name="0001-doc-improve-PQauthDataHook_type-definition.patch"
Content-Disposition: attachment;
	filename="0001-doc-improve-PQauthDataHook_type-definition.patch"
Content-Transfer-Encoding: base64
Content-ID: <f_mo5y04u60>
X-Attachment-Id: f_mo5y04u60

RnJvbSAxOTI1YzJmNDdhMjY4YWE2YTQ0M2I2ZjgwMWM2ZWE3YzE1MzVjZWVkIE1vbiBTZXAgMTcg
MDA6MDA6MDAgMjAwMQpGcm9tOiBEYW5pZWxlIFZhcnJhenpvIDxkYW5pZWxlLnZhcnJhenpvQGdt
YWlsLmNvbT4KRGF0ZTogU3VuLCAxOSBBcHIgMjAyNiAxNzo0MToxMyArMDIwMApTdWJqZWN0OiBb
UEFUQ0hdIGRvYzogaW1wcm92ZSBQUWF1dGhEYXRhSG9va190eXBlIGRlZmluaXRpb24KClVzZSB0
aGUgdHlwZWRlZiBuYW1lIHRvIG1ha2UgaXQgZWFzaWVyIHRvIGNvcnJlbGF0ZSB0byB0aGUgZnVu
Y3Rpb25zCnVzaW5nIHRoaXMgdHlwZSBkZWZpbml0aW9uLgotLS0KIGRvYy9zcmMvc2dtbC9saWJw
cS5zZ21sIHwgMiArLQogMSBmaWxlIGNoYW5nZWQsIDEgaW5zZXJ0aW9uKCspLCAxIGRlbGV0aW9u
KC0pCgpkaWZmIC0tZ2l0IGEvZG9jL3NyYy9zZ21sL2xpYnBxLnNnbWwgYi9kb2Mvc3JjL3NnbWwv
bGlicHEuc2dtbAppbmRleCBlNTBmMGNiZDhjNy4uZjY0NjI0NDg0MGQgMTAwNjQ0Ci0tLSBhL2Rv
Yy9zcmMvc2dtbC9saWJwcS5zZ21sCisrKyBiL2RvYy9zcmMvc2dtbC9saWJwcS5zZ21sCkBAIC0x
MDI4MCw3ICsxMDI4MCw3IEBAIHZvaWQgUFFzZXRBdXRoRGF0YUhvb2soUFFhdXRoRGF0YUhvb2tf
dHlwZSBob29rKTsKICAgICAgICAgZGVmYXVsdCBoYW5kbGVyIHdpbGwgYmUgcmVpbnN0YWxsZWQu
IE90aGVyd2lzZSwgdGhlIGFwcGxpY2F0aW9uIHBhc3NlcwogICAgICAgICBhIHBvaW50ZXIgdG8g
YSBjYWxsYmFjayBmdW5jdGlvbiB3aXRoIHRoZSBzaWduYXR1cmU6CiA8cHJvZ3JhbWxpc3Rpbmc+
Ci1pbnQgaG9va19mbihQR2F1dGhEYXRhIHR5cGUsIFBHY29ubiAqY29ubiwgdm9pZCAqZGF0YSk7
Cit0eXBlZGVmIGludCAoKlBRYXV0aERhdGFIb29rX3R5cGUpIChQR2F1dGhEYXRhIHR5cGUsIFBH
Y29ubiAqY29ubiwgdm9pZCAqZGF0YSk7CiA8L3Byb2dyYW1saXN0aW5nPgogICAgICAgICB3aGlj
aCA8YXBwbGljYXRpb24+bGlicHE8L2FwcGxpY2F0aW9uPiB3aWxsIGNhbGwgd2hlbiBhbiBhY3Rp
b24gaXMKICAgICAgICAgcmVxdWlyZWQgb2YgdGhlIGFwcGxpY2F0aW9uLiA8cmVwbGFjZWFibGU+
dHlwZTwvcmVwbGFjZWFibGU+IGRlc2NyaWJlcwotLSAKMi4zNC4xCgo=
--00000000000096017b064fd2319b--