aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHeikki Linnakangas <heikki.linnakangas@iki.fi>2014-12-16 15:39:57 +0200
committerHeikki Linnakangas <heikki.linnakangas@iki.fi>2014-12-16 15:41:58 +0200
commitda9f6a78ef84898ccdf7855089aa08e7524dfbdc (patch)
treed188107458591a3ae1d071e8a7ee35469dc2e5ce
parent0916eba131530b296f86137759a32f66ffedff7b (diff)
downloadpostgresql-da9f6a78ef84898ccdf7855089aa08e7524dfbdc.tar.gz
postgresql-da9f6a78ef84898ccdf7855089aa08e7524dfbdc.zip
Fix incorrect comment about XLogRecordBlockHeader.data_length field.
It does not include the possible full-page image. While at it, reformat the comment slightly to make it more readable. Reported by Rahila Syed
-rw-r--r--src/include/access/xlogrecord.h7
1 files changed, 4 insertions, 3 deletions
diff --git a/src/include/access/xlogrecord.h b/src/include/access/xlogrecord.h
index fbfad5ffba5..e5826eef24b 100644
--- a/src/include/access/xlogrecord.h
+++ b/src/include/access/xlogrecord.h
@@ -73,11 +73,12 @@ typedef struct XLogRecord
/*
* Header info for block data appended to an XLOG record.
*
+ * 'data_length' is the length of the rmgr-specific payload data associated
+ * with this block. It does not include the possible full page image, nor
+ * XLogRecordBlockHeader struct itself.
+ *
* Note that we don't attempt to align the XLogRecordBlockHeader struct!
* So, the struct must be copied to aligned local storage before use.
- * 'data_length' is the length of the payload data associated with this,
- * and includes the possible full-page image, and rmgr-specific data. It
- * does not include the XLogRecordBlockHeader struct itself.
*/
typedef struct XLogRecordBlockHeader
{