Possibly a comment typo in xlogrecord.h

Started by Rahila Syedabout 11 years ago2 messages

rahilasyed90@gmail.com

about 11 years ago

1 attachment(s)

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

Attachments:

correct_comment_typo_XLogRecordBlockHeader.patchapplication/octet-stream; name=correct_comment_typo_XLogRecordBlockHeader.patchDownload

diff --git a/src/include/access/xlogrecord.h b/src/include/access/xlogrecord.h
index fbfad5f..c6fd4b6 100644
--- a/src/include/access/xlogrecord.h
+++ b/src/include/access/xlogrecord.h
@@ -76,8 +76,8 @@ typedef struct XLogRecord
  * 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.
+ * and includes the rmgr-specific data. It does not include the possible
+ * full page image and XLogRecordBlockHeader struct itself.
  */
 typedef struct XLogRecordBlockHeader
 {

Heikki Linnakangas

hlinnakangas@vmware.com

about 11 years ago

In reply to: Rahila Syed (#1)

Re: Possibly a comment typo in xlogrecord.h

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

--
Sent via pgsql-hackers mailing list (pgsql-hackers@postgresql.org)
To make changes to your subscription:
http://www.postgresql.org/mailpref/pgsql-hackers