Editing errors in the comments of tableam.h and heapam.c
Hi,
Some comments in tableam.h and heapam.c contain three old function names
although these have been renamed by this commit
73b8c3bd2889fed986044e15aefd0911f96ccdd3.
Old: table_insert, table_fetch_row_version, table_get_latest_tid.
New: table_tuple_insert, table_tuple_fetch_row_version,
table_tuple_get_latest_tid.
I think these are editing errors. PG 12 also has the same errors.
Best regards,
Attachments:
editing-errors-correction-in-tableam-h-and-heapam-c.patchtext/plain; charset=UTF-8; name=editing-errors-correction-in-tableam-h-and-heapam-c.patch; x-mac-creator=0; x-mac-type=0Download
diff --git a/src/backend/access/heap/heapam.c b/src/backend/access/heap/heapam.c
index 7bd45703aa..5a0d5f9d27 100644
--- a/src/backend/access/heap/heapam.c
+++ b/src/backend/access/heap/heapam.c
@@ -1639,9 +1639,9 @@ heap_get_latest_tid(TableScanDesc sscan,
TransactionId priorXmax;
/*
- * table_get_latest_tid verified that the passed in tid is valid. Assume
- * that t_ctid links are valid however - there shouldn't be invalid ones
- * in the table.
+ * table_tuple_get_latest_tid verified that the passed in tid is valid.
+ * Assume that t_ctid links are valid however - there shouldn't be invalid
+ * ones in the table.
*/
Assert(ItemPointerIsValid(tid));
diff --git a/src/include/access/tableam.h b/src/include/access/tableam.h
index b3d2a6dd31..2fead15ecf 100644
--- a/src/include/access/tableam.h
+++ b/src/include/access/tableam.h
@@ -1003,10 +1003,10 @@ table_index_fetch_end(struct IndexFetchTableData *scan)
* that tuple. Index AMs can use that to avoid returning that tid in future
* searches.
*
- * The difference between this function and table_fetch_row_version is that
+ * The difference between this function and table_tuple_fetch_row_version is that
* this function returns the currently visible version of a row if the AM
* supports storing multiple row versions reachable via a single index entry
- * (like heap's HOT). Whereas table_fetch_row_version only evaluates the
+ * (like heap's HOT). Whereas table_tuple_fetch_row_version only evaluates the
* tuple exactly at `tid`. Outside of index entry ->table tuple lookups,
* table_tuple_fetch_row_version is what's usually needed.
*/
@@ -1062,8 +1062,8 @@ table_tuple_fetch_row_version(Relation rel,
/*
* Verify that `tid` is a potentially valid tuple identifier. That doesn't
* mean that the pointed to row needs to exist or be visible, but that
- * attempting to fetch the row (e.g. with table_get_latest_tid() or
- * table_fetch_row_version()) should not error out if called with that tid.
+ * attempting to fetch the row (e.g. with table_tuple_get_latest_tid() or
+ * table_tuple_fetch_row_version()) should not error out if called with that tid.
*
* `scan` needs to have been started via table_beginscan().
*/
@@ -1192,8 +1192,8 @@ table_tuple_complete_speculative(Relation rel, TupleTableSlot *slot,
/*
* Insert multiple tuples into a table.
*
- * This is like table_insert(), but inserts multiple tuples in one
- * operation. That's often faster than calling table_insert() in a loop,
+ * This is like table_tuple_insert(), but inserts multiple tuples in one
+ * operation. That's often faster than calling table_tuple_insert() in a loop,
* because e.g. the AM can reduce WAL logging and page locking overhead.
*
* Except for taking `nslots` tuples as input, and an array of TupleTableSlots
On Mon, Jul 13, 2020 at 02:25:39PM +0200, Hironobu SUZUKI wrote:
Some comments in tableam.h and heapam.c contain three old function names
although these have been renamed by this commit
73b8c3bd2889fed986044e15aefd0911f96ccdd3.Old: table_insert, table_fetch_row_version, table_get_latest_tid.
New: table_tuple_insert, table_tuple_fetch_row_version,
table_tuple_get_latest_tid.
Thanks. That looks right.
I think these are editing errors. PG 12 also has the same errors.
Yeah. We also recommend to look at tableam.h in the docs, so while
usually I just bother fixing comments on HEAD, it would be better to
back-patch this one.
--
Michael
On Mon, Jul 13, 2020 at 09:52:12PM +0900, Michael Paquier wrote:
Yeah. We also recommend to look at tableam.h in the docs, so while
usually I just bother fixing comments on HEAD, it would be better to
back-patch this one.
Committed and back-patched down to 12. Thanks, Suzuki-san.
--
Michael