Doc: add comments about PreventInTransactionBlock/IsInTransactionBlock.
authorTom Lane <tgl@sss.pgh.pa.us>
Wed, 9 Nov 2022 16:08:52 +0000 (11:08 -0500)
committerTom Lane <tgl@sss.pgh.pa.us>
Wed, 9 Nov 2022 16:08:52 +0000 (11:08 -0500)
commite613ace1f0d5734b62b133e9700300166ece1599
tree84138d5b8933e0dc729156b42efa843ed7460e83
parentb28ac1d24db44ae763a57688e7a559352002badc
Doc: add comments about PreventInTransactionBlock/IsInTransactionBlock.

Add a little to the header comments for these functions to make it
clearer what guarantees about commit behavior are provided to callers.
(See commit f92944137 for context.)

Although this is only a comment change, it's really documentation
aimed at authors of extensions, so it seems appropriate to back-patch.

Yugo Nagata and Tom Lane, per further discussion of bug #17434.

Discussion: https://postgr.es/m/17434-d9f7a064ce2a88a3@postgresql.org
src/backend/access/transam/xact.c