Thread: Possibly a comment typo in xlogrecord.h

Possibly a comment typo in xlogrecord.h

From
Rahila Syed
Date:
Hello,

The comment before declaration of XLogRecordBlockHeader says 

>* 'data_length' is the length of the payload data associated with this,
> * and includes the possible full-page image, and rmgr-specific data. It

IIUC, data_length does not include associated full page image length. Attached patch changes the comment as follows:

- * and includes the possible full-page image, and rmgr-specific data. It
- * does not include the XLogRecordBlockHeader struct itself.
+ * and includes the rmgr-specific data. It does not include the possible
+ * full page image and XLogRecordBlockHeader struct itself.

Thank you,
Rahila Syed
Attachment

Re: Possibly a comment typo in xlogrecord.h

From
Heikki Linnakangas
Date:
On 12/16/2014 12:44 PM, Rahila Syed wrote:
> Hello,
>
> The comment before declaration of XLogRecordBlockHeader says
>
>> * 'data_length' is the length of the payload data associated with this,
>> * and includes the possible full-page image, and rmgr-specific data. It
>
> IIUC, data_length does not include associated full page image length.
> Attached patch changes the comment as follows:
>
> - * and includes the possible full-page image, and rmgr-specific data. It
> - * does not include the XLogRecordBlockHeader struct itself.
> + * and includes the rmgr-specific data. It does not include the possible
> + * full page image and XLogRecordBlockHeader struct itself.

Thanks, fixed! I also reworded the comment slightly, hopefully it's more 
readable now.

- Heikki