From aff262665dd89a8459a08c6544536f0be49ac4b3 Mon Sep 17 00:00:00 2001 From: "Chao Li (Evan)" Date: Thu, 11 Sep 2025 13:32:38 +0800 Subject: [PATCH v3] Fix incorrect parameters in comments in tableam.h and heapam.c The function comment incorrectly referred to the input parameter as "relation". Updated it to "rel" to match the actual parameter name in tableam.h. Also removed non-existing parameter tid from commit of function heap_lock_tuple() in heapam.c. Author: Chao Li --- src/backend/access/heap/heapam.c | 1 - src/include/access/tableam.h | 16 +++++++++------- 2 files changed, 9 insertions(+), 8 deletions(-) diff --git a/src/backend/access/heap/heapam.c b/src/backend/access/heap/heapam.c index 4c5ae205a7a..ed0c0c2dc9f 100644 --- a/src/backend/access/heap/heapam.c +++ b/src/backend/access/heap/heapam.c @@ -4552,7 +4552,6 @@ get_mxact_status_for_lock(LockTupleMode mode, bool is_update) * * Input parameters: * relation: relation containing tuple (caller must hold suitable lock) - * tid: TID of tuple to lock * cid: current command ID (used for visibility test, and stored into * tuple's cmax if lock is successful) * mode: indicates if shared or exclusive tuple lock is desired diff --git a/src/include/access/tableam.h b/src/include/access/tableam.h index b2ce35e2a34..77eb41eb6dc 100644 --- a/src/include/access/tableam.h +++ b/src/include/access/tableam.h @@ -1433,17 +1433,18 @@ table_multi_insert(Relation rel, TupleTableSlot **slots, int nslots, * concurrent-update conditions. Use simple_table_tuple_delete instead. * * Input parameters: - * relation - table to be modified (caller must hold suitable lock) + * rel - table to be modified (caller must hold suitable lock) * tid - TID of tuple to be deleted * cid - delete command ID (used for visibility test, and stored into * cmax if successful) * crosscheck - if not InvalidSnapshot, also check tuple against this * wait - true if should wait for any conflicting update to commit/abort - * Output parameters: - * tmfd - filled in failure cases (see below) * changingPart - true iff the tuple is being moved to another partition * table due to an update of the partition key. Otherwise, false. * + * Output parameters: + * tmfd - filled in failure cases (see below) + * * Normal, successful return value is TM_Ok, which means we did actually * delete it. Failure return codes are TM_SelfModified, TM_Updated, and * TM_BeingModified (the last only possible if wait == false). @@ -1469,17 +1470,18 @@ table_tuple_delete(Relation rel, ItemPointer tid, CommandId cid, * concurrent-update conditions. Use simple_table_tuple_update instead. * * Input parameters: - * relation - table to be modified (caller must hold suitable lock) + * rel - table to be modified (caller must hold suitable lock) * otid - TID of old tuple to be replaced - * slot - newly constructed tuple data to store * cid - update command ID (used for visibility test, and stored into * cmax/cmin if successful) * crosscheck - if not InvalidSnapshot, also check old tuple against this * wait - true if should wait for any conflicting update to commit/abort + * * Output parameters: + * slot - newly constructed tuple data to store * tmfd - filled in failure cases (see below) * lockmode - filled with lock mode acquired on tuple - * update_indexes - in success cases this is set to true if new index entries + * update_indexes - in success cases this is set to true if new index entries * are required for this tuple * * Normal, successful return value is TM_Ok, which means we did actually @@ -1512,7 +1514,7 @@ table_tuple_update(Relation rel, ItemPointer otid, TupleTableSlot *slot, * Lock a tuple in the specified mode. * * Input parameters: - * relation: relation containing tuple (caller must hold suitable lock) + * rel: relation containing tuple (caller must hold suitable lock) * tid: TID of tuple to lock (updated if an update chain was followed) * snapshot: snapshot to use for visibility determinations * cid: current command ID (used for visibility test, and stored into -- 2.39.5 (Apple Git-154)