mirrors/postgres
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix incorrect comment about XLogRecordBlockHeader.data_length field.

Browse Source 
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
This commit is contained in:
Heikki Linnakangas 2014-12-16 15:39:57 +02:00
parent 0916eba131
commit da9f6a78ef
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
src/include/access/xlogrecord.h
View File

@ -73,11 +73,12 @@ typedef struct XLogRecord
/* /*
* Header info for block data appended to an XLOG record. * 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! * Note that we don't attempt to align the XLogRecordBlockHeader struct!
* So, the struct must be copied to aligned local storage before use. * 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 typedef struct XLogRecordBlockHeader
{ {