aboutsummaryrefslogtreecommitdiff
path: root/src/include/access/xlogrecord.h
diff options
context:
space:
mode:
authorAlvaro Herrera <alvherre@alvh.no-ip.org>2021-09-21 19:47:53 -0300
committerAlvaro Herrera <alvherre@alvh.no-ip.org>2021-09-21 19:47:53 -0300
commitade24dab97a20dae74fb57c0106dfe0e0303541b (patch)
treecd65f1b39138e8ee65cd7712c7402865eac42c58 /src/include/access/xlogrecord.h
parent43c1c4f65eab77bcfc4f535a7e9ac0421e0cf2a5 (diff)
downloadpostgresql-ade24dab97a20dae74fb57c0106dfe0e0303541b.tar.gz
postgresql-ade24dab97a20dae74fb57c0106dfe0e0303541b.zip
Document XLOG_INCLUDE_XID a little better
I noticed that commit 0bead9af484c left this flag undocumented in XLogSetRecordFlags, which led me to discover that the flag doesn't actually do what the one comment on it said it does. Improve the situation by adding some more comments. Backpatch to 14, where the aforementioned commit appears. Author: Álvaro Herrera <alvherre@alvh.no-ip.org> Discussion: https://postgr.es/m/202109212119.c3nhfp64t2ql@alvherre.pgsql
Diffstat (limited to 'src/include/access/xlogrecord.h')
-rw-r--r--src/include/access/xlogrecord.h5
1 files changed, 3 insertions, 2 deletions
diff --git a/src/include/access/xlogrecord.h b/src/include/access/xlogrecord.h
index e06ee92a5e5..8d1305eae83 100644
--- a/src/include/access/xlogrecord.h
+++ b/src/include/access/xlogrecord.h
@@ -215,8 +215,9 @@ typedef struct XLogRecordDataHeaderLong
* Block IDs used to distinguish different kinds of record fragments. Block
* references are numbered from 0 to XLR_MAX_BLOCK_ID. A rmgr is free to use
* any ID number in that range (although you should stick to small numbers,
- * because the WAL machinery is optimized for that case). A couple of ID
- * numbers are reserved to denote the "main" data portion of the record.
+ * because the WAL machinery is optimized for that case). A few ID
+ * numbers are reserved to denote the "main" data portion of the record,
+ * as well as replication-supporting transaction metadata.
*
* The maximum is currently set at 32, quite arbitrarily. Most records only
* need a handful of block references, but there are a few exceptions that