From: Heikki Linnakangas <heikki.linnakangas@iki.fi>
Date: Tue, 16 Dec 2014 13:39:57 +0000 (+0200)
Subject: Fix incorrect comment about XLogRecordBlockHeader.data_length field.
X-Git-Tag: REL9_5_ALPHA1~1051
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=da9f6a78ef84898ccdf7855089aa08e7524dfbdc;p=postgresql

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
---

diff --git a/src/include/access/xlogrecord.h b/src/include/access/xlogrecord.h
index fbfad5ffba..e5826eef24 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
 {